API do Zontalk

A API permite que outros sistemas conversem com o Zontalk: enviar mensagens, consultar dados e integrar o atendimento a aplicativos, sites e automações.

Abra Configurações → Automação e Integrações → API.

Criar uma configuração de API

Janela Criar Configuração API, com nome, canal e ativo

  1. Clique em Adicionar.
  2. Dê um nome à API, como o nome do sistema que vai usá-la.
  3. Em Enviar por, escolha o canal que fará os envios.
  4. Deixe Ativo ligado e clique em Salvar.

Cada configuração gera uma URL e um token de acesso. Você usa os dois no sistema que vai se conectar.

Guarde o token como uma senha. Quem o tiver pode enviar mensagens pelo seu canal. Não publique em sites, repositórios ou mensagens. Se ele vazar, exclua a configuração e crie outra.

Testar

  • Testar API: abre o Swagger UI, uma tela que lista os endpoints da API selecionada e permite testá-los no próprio navegador. Escolha a API no campo de cima.
  • Postman: o botão dá acesso à coleção da API para usar no Postman.

Atenção com canais desconectados

Se o canal de uma configuração for removido ou desconectado, a tela avisa "Canal WhatsApp não está mais disponível. Esta API deve ser excluída." Exclua a configuração antiga e crie uma nova com o canal correto.

Dicas

  • Crie uma configuração de API por sistema, para poder desativar uma sem afetar as outras.
  • Use nomes que digam para que serve, como "Formulário do site".
  • Para receber avisos do Zontalk, use Webhooks e N8N.