Começar
Introdução e autenticação
Base URL, chaves de API, escopos e os headers que valem para todos os endpoints.
URL base
Todos os endpoints públicos ficam sob /v1/product. Os SDKs já usam esta URL.
https://api.coffeemail.com.br/v1/productAutenticação
Envie a chave no header Authorization: Bearer. A chave aparece uma vez na criação; guarde num cofre de segredos.
Authorization
full_access- Lê e escreve em todos os recursos da organização.
sending_access- Só envia emails e consulta envios. Use em servidores que só disparam emails.
Nunca exponha a chave no navegador ou em apps móveis. Chame a API pelo seu backend.
Headers comuns
x-idempotency-key- Torna o envio idempotente por 24 h. Veja Idempotência e sandbox.
x-coffeemail-sandbox- Com true, o envio é validado mas não sai para o destinatário.
x-request-id- Volta em toda resposta; informe ao suporte.
retry-after- Volta com 429; segundos até poder tentar de novo.
Limites
Cada chave tem limite de requisições por segundo e cada plano tem cota mensal. Passou do limite, a API responde 429 com RATE_LIMIT_EXCEEDED ou PLAN_QUOTA_EXCEEDED.