Pular para o conteúdo principal
Este guia irá te levar do zero ao envio da sua primeira mensagem WhatsApp em menos de 5 minutos.

​
Pré-requisitos

  • Credenciais de API válidas (obtíveis no dashboard)
  • Conta WhatsApp Business (opcional, mas recomendada)
  • Cliente HTTP (curl, Postman ou código)

​
Passo 1: Obtenha sua Chave API

Primeiro, obtenha sua chave API no dashboard: 
curl -X GET "https://b0fe4081af63.ngrok-free.app/api/v1/api-keys" \
  -H "Authorization: ApiKey sua_api_key_aqui"

​
Passo 2: Criar Instância WhatsApp

Crie uma nova instância para conectar sua conta WhatsApp: 
curl -X POST "https://b0fe4081af63.ngrok-free.app/api/v1/instances" \
  -H "Authorization: ApiKey sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Minha Primeira Instância"
  }'
Salve o instanceId da resposta - você precisará dele para enviar mensagens.

​
Passo 3: Conectar WhatsApp (Código QR)

Obtenha o código QR para conectar sua conta WhatsApp: 
curl -X GET "https://b0fe4081af63.ngrok-free.app/api/v1/instances/{instanceId}/qrcode" \
  -H "Authorization: ApiKey sua_api_key_aqui"
A resposta conterá uma URL do código QR. Abra-a no seu navegador e escaneie com o WhatsApp.
Mantenha o código QR privado - qualquer pessoa que o escaneie terá acesso à sua conta WhatsApp.

​
Passo 4: Envie sua Primeira Mensagem

Depois de conectado, envie uma mensagem de teste: 
curl -X POST "https://b0fe4081af63.ngrok-free.app/api/v1/messages" \
  -H "Authorization: ApiKey sua_api_key_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "API",
    "mediaType": "TEXT",
    "content": "Olá da ApiZap! 🚀",
    "phone": "+5511999999999",
    "instanceId": "sua_instance_id"
  }'

​
Verificar Sucesso

Verifique o status da mensagem: 
curl -X GET "https://b0fe4081af63.ngrok-free.app/api/v1/messages/{messageId}" \
  -H "Authorization: ApiKey sua_api_key_aqui"

​
Próximos Passos

Enviar Mensagens de Mídia

Aprenda a enviar imagens, vídeos e documentos

Exemplos de Implementação

Veja exemplos práticos de uso da API

Operações em Lote

Enviar mensagens para múltiplos destinatários

Gerenciamento de Contatos

Organizar seus contatos e grupos

​
Solução de Problemas

  • Verifique se sua chave API está correta
  • Certifique-se de que o formato é: Authorization: ApiKey sua_chave
  • Verifique se a chave está ativa no dashboard
  • Certifique-se de que escaneou o código QR corretamente
  • Verifique o status da instância: GET /instances/{id}
  • Tente regenerar o código QR se expirou
  • Verifique o formato do número de telefone (+5511999999999)
  • Verifique se a instância está conectada e ativa
  • Certifique-se de que o destinatário tem o WhatsApp instalado
Sucesso! Você enviou sua primeira mensagem com ApiZap. Pronto para construir algo incrível? Confira a documentação completa da API.