Chaves de API e webhooks

1. 1

   Abra a seção “API”

   No menu abre API: aqui encontra a chave de programador (apikey) da sua conta.

2. 2

   Copie a chave

   Use-a para autenticar os seus pedidos. Trate-a como uma senha.

URL base

A API está no domínio da sua conta, com o prefixo /api (ex.: https://o-seu-dominio/api). Não uses “/v1” nem domínios diferentes.

Autenticação

Passe a chave no cabeçalho HTTP “X-API-Key”, ou como parâmetro “apikey” no pedido. Não se usa o bearer token.

Não partilhes a chave de API e não a inseras em código público (ex.: JavaScript no lado do navegador): quem tem a chave pode agir na sua conta. Se ficar exposta, regenera-a.

• Enviar mensagens (ex.: através do endpoint de envio do WhatsApp), dentro dos limites das regras do canal (na API oficial da Meta, para escrever primeiro é necessário um template aprovado).
• Gerenciar os contatos da lista.
• Criar uma nova Conta (bot) de forma programática.
• Registrar o URL do seu webhook para receber os eventos recebidos.

Os endpoints que aceitam a chave funcionam tanto com a conta titular como com um operador autorizado: atribui as chaves com critério consoante quem tem de fazer a integração.

Com os webhooks recebe em tempo real os eventos recebidos (ex.: uma nova mensagem de um canal). Registre o URL do seu endpoint através da API: a partir desse momento o SendApp envia os dados ao seu sistema quando o evento ocorre. É a forma de manter alinhado um CRM ou um software de gestão externo.

401 / não autorizado

Chave em falta ou errada: verifique o cabeçalho X-API-Key ou o parâmetro apikey.

URL errado

Use o domínio da sua conta com o prefixo /api, sem “/v1”.

Demasiados pedidos num endpoint

Alguns endpoints têm um limite de frequência: distribui as chamadas em vez de as concentrar.