Visão geral
A API REST permite ler e gravar dados da plataforma (contatos, conversas, mensagens e mais). A autenticação é por token de acesso, e os webhooks entregam eventos ao seu sistema em tempo real.
Pré-requisitos
- Token de acesso válido.
- Um endpoint HTTPS para receber webhooks.
Passo a passo
- Gere um token de acesso nas configurações.
- Inclua o token no cabeçalho de autenticação das chamadas à API.
- Faça requisições aos recursos da API (ex.: listar contatos, criar conversa).
- Configure um webhook informando a URL e os eventos desejados.
- Valide a assinatura/segredo do webhook antes de processar o payload.
Configurações & opções
- Escopo do token: limite o acesso ao necessário.
- Eventos do webhook: assine apenas os eventos que você usa.
- Reentrega: trate retentativas e idempotência no seu endpoint.
Casos de uso
- Espelhar conversas em um data warehouse.
- Notificar um sistema externo quando uma conversa é criada ou resolvida.
Dicas, limites e boas práticas
- Sempre verifique a assinatura do webhook antes de agir.
- Garanta idempotência (dedup por identificador do evento).
- Respeite limites de taxa e use backoff em erros 429/5xx.
Solução de problemas
- 401/403: token inválido ou sem permissão.
- Webhook duplicado: implemente dedup por ID do evento.