Pular para o conteúdo principal
Conceitos

Idempotência e sandbox

Como repetir uma requisição sem duplicar o email e como testar sem enviar de verdade.

Idempotência

Mande x-idempotency-key no POST /emails. Se a mesma chave chegar de novo em até 24 horas, a API devolve o mesmo email em vez de criar outro. Use um id do seu domínio, como pedido-4821-enviado.

Os SDKs aceitam a chave como campo do envio (idempotencyKey) e a convertem no header.

POST /emails
curl -X POST https://api.coffeemail.com.br/v1/product/emails \  -H "Authorization: Bearer $COFFEEMAIL_API_KEY" \  -H "x-idempotency-key: pedido-4821-enviado" \  -H "x-coffeemail-sandbox: true" \  -H "Content-Type: application/json" \  -d '{ "from": { "email": "pedidos@acme.com.br" }, "to": [{ "email": "ana@exemplo.com.br" }], "subject": "Teste", "html": "<p>Oi</p>" }'

Sandbox

Com x-coffeemail-sandbox: true, o email passa por todas as validações e gera eventos, mas não sai para o destinatário. Serve para testes automatizados e ambientes de desenvolvimento.

Chaves de teste ligam o sandbox sozinhas. O plano precisa ter sandbox disponível.