Documentação da API
A API pública — documentação dos endpoints, criação de API Keys com permissões e expiração, e o playground para testar com requisições reais.
Documentação (/dashboard/api) é o portal da API da plataforma, para integrar seus sistemas (loja virtual, ERP, CRM, formulários) com o WhatsApp. Três abas: Documentação, API Keys e Testar.
O topo mostra seu Plano, o Rate limit (requisições por minuto) e os limites de Conexões e Contatos.
Autenticação
Toda requisição leva a sua API Key no cabeçalho:
Authorization: Bearer SUA_API_KEY
Aba Documentação
Endpoints agrupados por categoria. Cada um mostra método, caminho, descrição, Parâmetros (com "obrigatório"), exemplos de código (cURL, JavaScript, Python...) e a Resposta (application/json).
| Categoria | Endpoint | Função |
|---|---|---|
| Início | GET /api/v1/health |
Health Check — testa se a API responde. |
GET /api/v1/permissions |
Listar Permissões da chave usada. | |
| Mensagens | POST /api/v1/messages/send |
Enviar Mensagem. |
| Contatos | GET /api/v1/contacts |
Listar Contatos. |
POST /api/v1/contacts |
Criar Contato. | |
| Disparos | POST /api/v1/dispatches |
Criar Disparo. |
GET /api/v1/dispatches/:id/status |
Status do Disparo. | |
| Conversas | GET /api/v1/conversations |
Listar Conversas. |
| Conexões | GET /api/v1/connections |
Listar Conexões. |
| Webhooks | POST /api/v1/webhooks |
Registrar Webhook (receber eventos no seu sistema). |
GET /api/v1/webhooks |
Listar Webhooks. |
Aba API Keys
Lista suas chaves com nome, permissões, status (Ativa / Revogada) e o botão de revogar ("Revogar "
Nova API Key
| Campo | Detalhe |
|---|---|
| Nome | Ex.: "Integração CRM". |
| Permissões | Marque só o necessário (veja a tabela). |
| Expiração | Nunca expira, 7 dias, 30 dias, 90 dias ou 1 ano. |
O Rate Limit (req/min) vem do seu plano.
| Permissão | Libera |
|---|---|
messages:write |
Enviar mensagens |
messages:read |
Ler mensagens |
contacts:read |
Listar contatos |
contacts:write |
Criar/editar contatos |
dispatches:read |
Ver disparos |
dispatches:write |
Criar disparos |
conversations:read |
Ler conversas |
connections:read |
Listar conexões |
webhooks:read |
Ver webhooks |
webhooks:write |
Gerenciar webhooks |
Criar abre API Key Criada! — "Copie agora! Esta é a única vez que será exibida." Copie e clique em Entendi, já copiei.
Guarde a chave num lugar seguro (gerenciador de senhas, variável de ambiente do servidor). Nunca coloque a chave em código que roda no navegador ou num aplicativo público. Se vazar, revogue e crie outra.
Aba Testar (playground)
Testar endpoints — "Requisições reais, com uma das suas chaves. O que você testar aqui vira o comando cURL abaixo."
- API Key — escolha a chave. "As chaves só são exibidas por inteiro no momento da criação. Para testar aqui, crie uma chave nova e copie o valor."
- Endpoint — escolha; aparece a Permissão exigida.
- Corpo (JSON) — para POST (validado: "Corpo não é um JSON válido").
- Executar — mostra a resposta real.
- cURL equivalente — copie para usar no terminal ou no seu sistema.
Referência completa abre a documentação completa, e Instruções para IA copia um "texto pronto para colar num assistente de IA" (ChatGPT, Claude...) para ele escrever a integração para você.
O playground faz requisições de verdade: "Enviar Mensagem" envia mesmo. Teste com o seu próprio número.