Sandbox
Conceituacao
O Sandbox e um ambiente de testes que simula o envio e recebimento de mensagens WhatsApp sem a necessidade de um numero de telefone real. Com ele, voce pode desenvolver e testar sua integracao com a Ogmma API de forma segura, sem impactar canais de producao.
Para acessar o ambiente sandbox, utilize uma API key com o prefixo oapi_sk_test_. Todas as requisicoes feitas com chaves de teste sao automaticamente direcionadas ao sandbox.
Recursos disponiveis
| Recurso | Descricao |
|---|---|
| Envio simulado de mensagens | Mensagens sao entregues instantaneamente com status DELIVERED |
| Recebimento simulado | Simule mensagens de entrada para testar seus webhooks |
| Teste de webhooks | Todos os eventos de webhook sao disparados normalmente |
| Simulacao de erros | Use o header X-Ogmma-Sandbox-Scenario para simular cenarios de erro |
Como funciona
- Crie uma API key de teste - Gere uma chave com prefixo
oapi_sk_test_no painel ou via endpoint de criacao. - Faca requisicoes normalmente - Use os mesmos endpoints da API de producao, autenticando com a chave de teste.
- Mensagens sao simuladas - O sandbox processa as mensagens instantaneamente, sem enviar para o WhatsApp real.
- Webhooks sao disparados - Os eventos de webhook funcionam normalmente, permitindo testar seu fluxo completo.
Permissao necessaria
Para acessar os endpoints do sandbox, sua API key deve possuir a permissao sandbox.write.
Retencao de dados
Os dados do sandbox sao retidos por 30 dias. Apos esse periodo, mensagens e dados de teste sao automaticamente removidos. Voce tambem pode limpar os dados manualmente a qualquer momento usando o endpoint DELETE /api/sandbox/data.
Use o sandbox para testar todo o seu fluxo de integracao antes de conectar um canal real. Isso evita problemas com numeros de telefone e garante que sua aplicacao esteja pronta para producao.