Skip to main content

Autenticação

A API do Portal usa Bearer Token no header Authorization. O método recomendado para integrações e o Token de Acesso Pessoal (PAT).

Tipos de credencial

Este manual cobre o caso de uso de PAT, que e o canal oficial para integradores externos.

Criando um PAT

1

Acesse Perfil → Segurança

No painel, clique no seu avatar e va em Perfil, depois aba Segurança.
2

Criar Token

Clique em Criar Token, escolha um nome descritivo (ex: crm-integration-prod) e defina a validade.
3

Copie o token

O token começa com pat_ e e exibido uma única vez. Guarde em local seguro (cofre, variável de ambiente).
Trate o PAT como uma senha. Ele concede acesso integral as suas entidades. Se vazar, revogue imediatamente no mesmo lugar onde foi criado.

Usando o token

Inclua o header Authorization em toda requisição:
Exemplo em Python:
Exemplo em Node.js (fetch):

Validade e renovação

PATs podem ser criados com as validades:
  • Nunca expira — para integrações permanentes em backends controlados.
  • 30 / 90 / 365 dias — para integrações temporarias ou de menor confianca.
Quando o token expira, qualquer requisição retorna 401 Unauthorized. Não ha refresh: gere um novo token e atualize o segredo na sua integração.

Revogando um token

Em Perfil → Segurança, clique em Revogar ao lado do token. A revogação e imediata — todas as requisições subsequentes que usem aquele token receberão 401.
Use um PAT por integração em vez de reaproveitar o mesmo token em multiplos serviços. Isso permite revogar somente o serviço comprometido sem derrubar os demais.

Erros comuns

Veja Limites e Erros para o detalhamento completo.