Primeiros passos
O caminho mínimo entre configurar a API e receber o primeiro evento.
Este roteiro usa o contrato atual. A base URL local padrão é http://localhost:8084; ajuste host e porta conforme seu ambiente.
URL base
Use http://localhost:8084 apenas no desenvolvimento local. Em outros ambientes, informe a URL HTTPS publicada pela sua infraestrutura; o código não define um domínio público único.
Fluxo em quatro etapas
- Configure o servidor e o token global em Instalação e ambiente.
- Crie uma instância com
POST /instancee guarde o JWT retornado emAuth.token. - Conecte o WhatsApp por QR Code, pairing code ou Passkey.
- Envie uma mensagem e depois configure webhooks para receber eventos.
Credenciais diferentes
| Credencial | Header recomendado | Onde usar |
|---|---|---|
| Token global | apikey: $GLOBAL_TOKEN | Criar/listar instâncias e administrar envios em lote |
| JWT da instância | Authorization: Bearer $INSTANCE_TOKEN | Conexão, mensagens, chats, mídia, grupos e webhooks |
O JWT contém instanceName. Se ele pertencer a outra instância, o servidor retorna 403.
Verifique o servidor
curl "http://localhost:8084/health"
curl "http://localhost:8084/ready"/health confirma que o processo está ativo. /ready também verifica dependências necessárias para receber tráfego.
Próximo passo
Abra a referência API interativa para navegar pelas operações, schemas, exemplos e códigos de resposta diretamente do OpenAPI sincronizado.