Início rápido: da conta à primeira mensagem

Troque as chaves de exemplo pelas suas, em Configurações e API no painel, e {instanceId} pelo ID da instância.

1. Passo 1

   Pegue suas chaves de API

   No painel, em Configurações e API, copie a chave e o segredo. Toda requisição leva os cabeçalhos x-api-key e x-api-secret.

   Autenticação

2. Passo 2

   Confira o custo de criar uma instância

   Antes de criar, consulte a taxa de ativação, o valor proporcional e o saldo necessário.

   curl

   curl https://api.zapzapapi.com/api/v1/instances/cost \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET"

   Custo de Criação

3. Passo 3

   Crie a instância

   O nome aceita apenas letras, números, _ e -. A criação debita do saldo a taxa de ativação e o valor proporcional do mês. A instância nasce com status PENDING.

   curl

   curl -X POST https://api.zapzapapi.com/api/v1/instances \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET" \
     -H "Content-Type: application/json" \
     -d '{"name":"minha-instancia"}'

   Criar Instância

4. Passo 4

   Conecte o número lendo o QR code

   Peça o QR code da instância e leia com o celular, em WhatsApp, Aparelhos conectados. Você também pode conectar pelo painel.

   curl

   curl https://api.zapzapapi.com/api/v1/instances/{id}/qrcode \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET"

   QR Code da Instância

5. Passo 5

   Confirme que a instância está conectada

   Consulte os detalhes da instância e espere o status CONNECTED.

   curl

   curl https://api.zapzapapi.com/api/v1/instances/{id} \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET"

   Detalhes da Instância

6. Passo 6

   Envie a primeira mensagem

   O número leva o código do país (DDI), por exemplo 5511999999999. O envio mostra o digitando automático antes de entregar.

   curl

   curl -X POST https://api.zapzapapi.com/api/v1/{instanceId}/send/text \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET" \
     -H "Content-Type: application/json" \
     -d '{"number":"5511999999999","text":"Olá! Tudo bem?"}'

   Enviar Texto

7. Passo 7

   Receba eventos por webhook

   Informe uma URL pública em HTTPS para receber mensagens, status de entrega e mudanças de conexão. Depois envie um evento de teste e confira as entregas recentes.

   curl

   curl -X PUT https://api.zapzapapi.com/api/v1/instances/{id}/webhook \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET" \
     -H "Content-Type: application/json" \
     -d '{"webhook_url":"https://example.com/webhook"}'
   
   curl -X POST https://api.zapzapapi.com/api/v1/instances/{id}/webhook/test \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET"
   
   curl https://api.zapzapapi.com/api/v1/instances/{id}/webhook/deliveries \
     -H "x-api-key: SUA_API_KEY" \
     -H "x-api-secret: SEU_API_SECRET"

   Configurar Webhook