API: como autenticar e fazer a primeira chamada

Este artigo mostra como montar o endereço da API, enviar o token e fazer a primeira chamada de teste. Antes, crie a configuração da API, como explica o artigo API do Zontalk.

O que você precisa

Cada configuração de API tem duas informações:

  • URL: o endereço da sua API. Ela termina com um código único da sua configuração, neste formato:

    https://api.Zontalk.shop/v1/api/external/SEU_ID_DA_API

  • Token: a chave de acesso, que você envia em toda chamada.

Nos exemplos deste artigo, SEU_ID_DA_API e SEU_TOKEN são valores de mentira. Troque pelos da sua configuração.

Guarde o token como uma senha. Quem o tiver envia mensagens pelo seu canal. Não coloque em sites, repositórios nem mensagens.

Como enviar o token

Toda chamada precisa do cabeçalho Authorization, com a palavra Bearer, um espaço e o token:

Authorization: Bearer SEU_TOKEN

O corpo das chamadas é JSON. Envie também o cabeçalho Content-Type:

Content-Type: application/json

Primeira chamada: ver o status do canal

A forma mais simples de testar é perguntar como está o canal. Não envia nada a ninguém.

curl "https://api.Zontalk.shop/v1/api/external/SEU_ID_DA_API/statuschannel" \
  -H "Authorization: Bearer SEU_TOKEN"

Se a resposta vier com os dados do canal, a URL e o token estão certos. Se vier erro de autorização, confira se o token foi copiado inteiro e se a configuração da API está ativa.

Segunda chamada: enviar uma mensagem

curl -X POST "https://api.Zontalk.shop/v1/api/external/SEU_ID_DA_API" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"number": "5511999999999", "body": "Olá! Mensagem de teste."}'

O envio de mensagens tem seu próprio artigo, com todas as opções: API: enviar mensagens.

Regras que evitam a maioria dos erros

  • Número de telefone: só dígitos, com código do país e DDD, sem espaços, parênteses ou sinal de mais. Exemplo: 5511999999999.
  • Acentos e emojis: envie o corpo em UTF-8. Se o texto chegar com caracteres estranhos (por exemplo "Ag�ncia"), o sistema que faz a chamada está enviando em outra codificação.
  • Endereços: os caminhos (como /createcontact) vêm depois da URL da sua API, sem barra duplicada.
  • Um sistema por configuração: crie uma API para cada sistema, para poder desativar uma sem afetar as outras.

Testar sem programar

Em Configurações → Automação e Integrações → API, o botão Testar API abre o Swagger, onde você escolhe a API e executa as chamadas no próprio navegador. O botão Postman dá acesso à coleção com todos os exemplos prontos.

Próximos passos