Skip to main content

Gerar tokens de API para integrações

Um token de API é uma chave que permite que sistemas externos (como o n8n, Zapier ou um sistema próprio) acessem os dados da sua conta pela API do AtendeBot. Aqui você gera, copia e, quando necessário, revoga esses tokens.

Objetivo

Gerar um token de API para conectar um sistema externo à sua conta.

Pré-requisitos

  • Perfil Administrador.

Tempo estimado

2 minutos.

Caminho de acesso

Ajustes → Integrações → API

Passo a passo

  1. Abra Ajustes → Integrações e clique na sub-aba API.

Ajustes → Integrações na sub-aba API, com a lista Tokens de API e o botão Gerar novo token em destaque

  1. Clique em Gerar novo token.

  2. Em Nome, escreva um nome que identifique o uso (ex.: Integração N8N).

    No WhatsApp não oficial (UazAPI), o nome do token vira a assinatura das mensagens enviadas por ele: o contato recebe *Integração N8N:* na primeira linha. Nos demais canais (WhatsApp Oficial, Instagram, Messenger, Z-API), o texto sai sem assinatura por padrão — o nome do token continua identificando a mensagem só dentro do AtendeBot. Escolha um nome apresentável, ou peça para quem configura a integração enviar o campo sender_name com o nome que deve aparecer no WhatsApp do contato (ou null para não assinar).

  3. Em Escopos, marque o que a integração vai usar: cada linha é um recurso da API (Atendimentos, Mensagens, Contatos, Negócios…) com duas caixas, Leitura e Escrita. As caixas do cabeçalho marcam a coluna inteira; Somente leitura, Tudo e Limpar são atalhos. É preciso marcar ao menos um escopo. Quando a integração pedir um escopo que o token não tem, a API responde 403 INSUFFICIENT_SCOPE com a lista do que falta, pronta para marcar aqui. Clique em Gerar token.

Janela Gerar novo token de API com o nome, a matriz de escopos por recurso (leitura e escrita) e o contador de escopos marcados

  1. A tela Token gerado com sucesso mostra a chave. Clique no ícone de copiar e guarde o token em local seguro.

O token completo é exibido uma única vez. Copie e guarde agora — depois de fechar, ele não será mostrado novamente. Se perder, gere um novo.

  1. Clique em Fechar. O token passa a aparecer na lista, exibindo apenas o início da chave, a marca ATIVO e os escopos que ele carrega.

Consultar a documentação

No topo da sub-aba API, o link Documentação da API abre a referência técnica para quem vai configurar a integração.

Editar os escopos de um token

Clique em Editar escopos na linha do token, ajuste a matriz e clique em Salvar escopos. A lista salva substitui a anterior. Token criado antes dos escopos aparece com o selo Acesso total: ele alcança toda a API. Abra Editar escopos, marque só o que a integração usa e salve — o selo some e o token passa a valer apenas para o que foi marcado.

Revogar um token

Se um token vazou ou não é mais usado, clique em Revogar na linha dele e confirme em Revogar. A ação é irreversível: qualquer integração que use aquele token perde o acesso na hora, e o token passa a exibir REVOGADO.

Resultado esperado

O novo token aparece na lista Tokens de API com a marca ATIVO, o início da chave e a data de criação. O sistema externo já pode usá-lo para autenticar as chamadas à API.

Erros comuns

  • Sintoma: fechei sem copiar o token. Solução: não há como recuperar a chave completa. Gere um novo token e atualize a integração.
  • Sintoma: a integração parou de funcionar de repente. Solução: confira se o token não foi Revogado e se ainda está ATIVO na lista.
  • Sintoma: a API responde 403 INSUFFICIENT_SCOPE. Solução: o token não tem o escopo daquela operação. A resposta lista o que falta em missing_scopes; abra Editar escopos e marque.

Artigos relacionados

  • webhooks
  • conectar-whatsapp-uazapi
  • papeis-permissoes