ByDomuDevelopers

Modo de teste

Chaves de teste com dados de exemplo: integre sem tocar nos seus dados reais nem esperar aprovação.

GuiaSem aprovaçãoDados de exemplo
Como no Stripe. Integre com o ByDomu sem tocar nos seus dados reais nem esperar aprovação. Cada conta tem um modo de teste.

Chaves de teste

Em Configurações › Chaves de API escolha Teste e crie uma chave: domu_sk_test_… (secreta, para seu servidor) ou domu_pk_test_… (publicável, para seu site). Têm todas as permissões (escritas, mensagens e webhooks) sem solicitar acesso, também durante o teste grátis; basta ter o e-mail verificado. Limite: 100 requisições e 30 escritas por minuto.

Sua organização de teste

Com sua primeira chave de teste criamos uma organização de teste com dados de exemplo: contatos, compromissos, tarefas e conversas, e também imóveis e negócios se sua conta for imobiliária. Não há dados pessoais reais. Uma chave de teste só vê e altera essa organização, e uma chave de produção nunca a vê.

Como saber em que modo você está

Cada resposta traz o cabeçalho X-Domu-Mode: test (ou live), e GET /v1/me devolve "mode": "test" e "livemode": false.

cURL
curl https://api.bydomu.com/v1/me -i \
  -H "X-API-Key: $BYDOMU_API_KEY"

# X-Domu-Mode: test
# { "data": { "mode": "test", "livemode": false, … } }

Nada sai de verdade

  • A organização de teste não envia WhatsApp, Instagram, Facebook, e-mail, SMS nem notificações.
  • Também não há cobranças, publicações em portais ou Meta Ads, nem chamadas à IA.
  • As mensagens ficam salvas como enviadas e seu id começa com wamid.sim_.

Webhooks

São entregues igual à produção, com a mesma assinatura X-Domu-Signature e as mesmas novas tentativas. O envelope leva "livemode": false; os de produção, "livemode": true. Para testar seu receptor sem esperar um evento real:

cURL
curl -X POST https://api.bydomu.com/v1/test/events \
  -H "X-API-Key: domu_sk_test_…" -H "Content-Type: application/json" \
  -d '{"type":"deal.won"}'

O evento sai com os dados do registro mais recente desse objeto na sua organização de teste e traz "test": true.

Começar do zero

POST /v1/test/reset (com uma chave secreta de teste) ou o botão Reiniciar dados de teste apaga tudo e recarrega os dados de exemplo. Suas chaves, o id da organização e seus webhooks são mantidos.

cURL
curl -X POST https://api.bydomu.com/v1/test/reset \
  -H "X-API-Key: domu_sk_test_…"

Ir para produção

Troque a chave por uma domu_sk_live_… e confira no seu receptor de webhooks que livemode seja true. As operações /v1/test/* respondem 403 TEST_MODE_ONLY com chaves de produção.

MCP

O servidor MCP aceita domu_sk_test_… igual a uma chave live; o assistente só verá os dados de exemplo.