Saltar para o conteúdo
Documentação
Índice do manual

🔌 Tokens de API

Em 30 segundos

  • Um token deixa o Make, o Zapier ou os teus próprios scripts ler ou escrever na oficina sem que haja uma pessoa à frente.
  • Está incluído nos planos Max e Business, e são os Admins e Proprietários que o criam.
  • A chave só se vê uma vez, ao criá-la: copia-a nesse momento.
  • Dá ao token o papel mínimo de que precise, e desativa-o quando já não o usares.

Os tokens de API permitem ligar o BolloPrint a ferramentas externas como o Make (Integromat), Zapier, scripts próprios ou qualquer sistema que precise de ler ou escrever dados na oficina sem que haja uma pessoa à frente.

Estão disponíveis em Configurações → Extensões → Tokens API para Admins e Proprietários.

A API está incluída nos planos Max e Business. Se o teu plano não a incluir, a secção aparece bloqueada e as chamadas com token são recusadas mesmo que o token exista.


O que pode fazer uma integração com um token de API?

Dependendo do papel que atribuis ao token, uma integração pode:

  • Criar encomendas automaticamente quando chega uma venda de outra plataforma.
  • Ler o estado das encomendas para atualizar um sistema externo de seguimento.
  • Adicionar clientes em massa a partir de uma importação.
  • Consultar o inventário para alertas de stock.

O token atua em nome de um utilizador "sistema" da oficina, não de uma pessoa concreta.


Criar um token de API

  1. Vai a Configurações → Extensões → Tokens API.
  2. Carrega em "Criar token".
  3. Preenche o formulário:
    • Nome: algo descritivo para saber para que serve (p. ex. "Make — encomendas web").
    • Papel: o nível de acesso do token (Admin, Trabalhador ou Só leitura). Usa o mínimo necessário.
    • Validade: quanto tempo o token estará ativo (1 semana, 1 mês, 3 meses, 1 ano, ou Nunca expira).
  4. Carrega em Criar token.

🔐 O token mostra-se apenas uma vez

Imediatamente após criar o token, o sistema mostra a chave completa. Copia-a nesse momento — não é possível vê-la de novo. Se a perderes, terás de criar um token novo e desativar o anterior.


O token começa por bp_tat_

Todos os tokens de oficina começam com o prefixo bp_tat_ (BolloPrint Tenant API Token). É fácil de identificar se tens vários tokens num gestor de palavras-passe.


Papéis do token

PapelO que pode fazer
AdminAcesso completo (leitura e escrita em todos os módulos).
TrabalhadorO mesmo que uma pessoa com papel Trabalhador: gere encomendas, clientes, catálogo.
Só leituraSó consulta, não modifica nada. Útil para integrações que só precisam de consultar dados.

Desativar um token

Se já não precisas de um token mas queres conservar o histórico do que fez, usa Desativar. O token deixa de funcionar mas permanece na lista.

Se quiseres eliminá-lo completamente da lista, usa Eliminar (só disponível em tokens já desativados ou caducados).


Auditoria de utilização

Sempre que uma integração chama a API usando um token, o BolloPrint regista a ação no histórico da encomenda ou do orçamento que modifica. Em vez do nome de uma pessoa, como autor verás o nome do token.


Quem pode gerir tokens de API?

Apenas Admins e Proprietários podem criar, ver e desativar tokens. Os Trabalhadores e Só leitura não têm acesso a esta secção.