Começar
Chaves e modo teste
Uma chave diz em qual ambiente você está, o que pode fazer e quanto pode enviar.
Teste e produção
| Teste | Produção | |
|---|---|---|
| Começa com | oszt_ | osz_ |
| Envios | Simulados: nada sai para o WhatsApp | De verdade, pelo número da empresa |
| Dados | Ambiente separado: contatos, conversas, número fictício e cópia dos templates aprovados | Os da empresa |
| Resposta | Traz "modo": "teste" e o cabeçalho X-OneSendz-Modo: teste | Normal |
| Custo da Meta | Nenhum | Cobrado pela Meta, direto na conta da empresa |
Uma chave de teste nunca envia de verdade. Ela fica presa ao ambiente de teste no servidor: mesmo que o seu código tenha um erro, nada chega a ninguém.
Como criar
Enquanto o console do Developers não chega, as chaves são criadas no painel da OneSendz por administradores e gerentes: Configurações → Integrações → API e MCP → Nova chave. Você escolhe:
- Ambiente: Teste (padrão) ou Produção.
- Permissões: leitura (sempre), escrita e envio.
- Tope de envios (opcional): máximo por dia e por mês.
A chave inteira aparece uma vez só. Perdeu? Revogue e crie outra.
Permissões
| Permissão | Libera |
|---|---|
read (leitura) | Contatos, conversas, templates, campanhas, automações, resumos |
write (escrita) | Salvar contatos e etiquetas, criar webhooks, rascunhos de campanha e de automação |
send (envio) | Mandar mensagens e templates. Conta no limite de envios |
Chamou uma ferramenta sem a permissão: 403 sem_permissao, dizendo qual falta. A referência mostra a permissão de cada ferramenta.
Topes de envio
O tope protege contra um erro no código disparando mensagens em massa (um laço infinito, um reenvio sem fim). Ele nunca passa do limite do plano. Chegou no tope: 429 limite_de_envios_por_dia ou limite_de_envios_por_mes, e a chave volta sozinha no dia (meia-noite UTC) ou no mês seguinte.
Segurança
- Só no servidor. Guarde a chave em variável de ambiente ou nos segredos do projeto. Nunca no código que roda no navegador nem num repositório.
- Uma chave por sistema. Fica fácil ver o uso de cada um e revogar só o que precisar.
- A chave age em nome de quem a criou. Se essa pessoa sair da empresa, a chave para (
403 chave_sem_dono) até um administrador assumir no painel. - Revogar é na hora. Desconfiou, revogue no painel: a chave para de funcionar no mesmo instante.