Começar em 5 minutos

Do zero à primeira mensagem (simulada) pela API oficial do WhatsApp. Tudo aqui roda no modo teste: nada chega a ninguém até você trocar a chave.

1. Pegue uma chave de teste

   O acesso ao Developers está sendo liberado aos poucos, pela lista de espera. Enquanto o console próprio não chega, a chave é criada no painel da OneSendz: Configurações → Integrações → API e MCP → Nova chave, ambiente Teste.

   A chave de teste começa com oszt_. Guarde numa variável de ambiente, por exemplo ONESENDZ_API_KEY. Ela aparece uma vez só.

2. Faça a primeira chamada

   Toda ferramenta da API é um POST em https://dev.onesendz.com/api/v1/<nome>, com a chave no cabeçalho.

   bashCopiar

   curl -X POST https://dev.onesendz.com/api/v1/quem_sou \
     -H "Authorization: Bearer $ONESENDZ_API_KEY"

   A resposta mostra a conta, a chave e "modo": "teste":

   jsonCopiar

   { "ok": true, "modo": "teste", "dados": { "conta": { "nome": "Minha empresa (teste da API)" }, "conexao": { "nome": "meu-app" } } }

3. Salve um contato e mande um template

   Fora da janela de 24 horas, o WhatsApp só aceita template aprovado. No modo teste você tem uma cópia dos templates aprovados da empresa: veja com listar_templates.

   bashCopiar

   curl -X POST https://dev.onesendz.com/api/v1/salvar_contato \
     -H "Authorization: Bearer $ONESENDZ_API_KEY" -H "Content-Type: application/json" \
     -d '{"telefone": "+5511999990000", "nome": "Cliente Teste"}'
   
   curl -X POST https://dev.onesendz.com/api/v1/enviar_template \
     -H "Authorization: Bearer $ONESENDZ_API_KEY" -H "Content-Type: application/json" \
     -d '{"telefone": "+5511999990000", "template": "boas_vindas", "chave_idempotencia": "pedido-123-boas-vindas"}'

   Volta um mensagem_id. No modo teste o envio é simulado e marcado como enviado em alguns segundos.

4. Receba o resultado por webhook

   Cadastre um endereço https para saber quando a mensagem foi entregue, lida ou não chegou (com o motivo):

   bashCopiar

   curl -X POST https://dev.onesendz.com/api/v1/criar_webhook \
     -H "Authorization: Bearer $ONESENDZ_API_KEY" -H "Content-Type: application/json" \
     -d '{"url": "https://seu-app.com/webhooks/onesendz", "eventos": ["mensagem.recebida", "mensagem.entregue", "mensagem.falhou"]}'

   Guarde o segredo que volta: ele confere a assinatura de cada aviso. Veja Receber: webhooks.

5. Vá para produção

   Quando tudo funcionar, crie uma chave de Produção (osz_) e troque a variável. Nada mais muda no código.

Próximos passos