← Voltar
Guide

Quickstart

Do zero ao primeiro envio em ~5 minutos.

1

Criar conta e parear WhatsApp

Crie sua conta em simpleszap.com e pareie um número WhatsApp via QR code (Instâncias → Nova instância). O número fica disponível enquanto o status estiver connected.

2

Gerar uma API key

No painel, vá em Configurações → API Keys e clique em Criar nova chave. Copie o valor sk_... — ele é mostrado uma vez só.

⚠ A chave herda o plano da sua conta. Limite diário e features (webhooks, templates) seguem o que está contratado.
3

Pegar o instanceId

curl https://back.simpleszap.com/api/instances \
  -H "x-api-key: sk_..."

A resposta lista as instâncias da conta. Copie o id da instância que vai usar para enviar.

4

Enviar a primeira mensagem

curl -X POST https://back.simpleszap.com/api/message/sendText/INSTANCE_ID \
  -H "x-api-key: sk_..." \
  -H "Content-Type: application/json" \
  -d '{"number":"5511999999999","text":"Olá!"}'

Resposta 200 OK = enviado. A mensagem fica registrada em GET /messages e o contador diário avança.

5

(Opcional) Receber callbacks via webhook

Para receber notificações de message.sent e message.failed, cadastre uma URL em Configurações → Webhooks ou via POST /webhooks/config.

{
  "event": "message.sent",
  "orgId": "...",
  "data": { "instanceId": "...", "number": "5511...", "text": "Olá!" }
}

Próximos passos