Saltar al contenido principal
Empezar

Introducción y autenticación

URL base, claves de API, alcances y los headers que valen para todos los endpoints.

URL base

Todos los endpoints públicos están bajo /v1/product. Los SDKs ya usan esta URL.

https://api.coffeemail.com.br/v1/product

Autenticación

Envía la clave en el header Authorization: Bearer. La clave aparece una sola vez al crearla; guárdala en un almacén de secretos.

Authorization
curl https://api.coffeemail.com.br/v1/product/emails?limit=1 \  -H "Authorization: Bearer cm_live_sua_chave"
full_access
Lee y escribe en todos los recursos de la organización.
sending_access
Solo envía emails y consulta envíos. Úsala en servidores que solo disparan emails.
Nunca expongas la clave en el navegador ni en apps móviles. Llama a la API desde tu backend.

Headers comunes

x-idempotency-key
Hace el envío idempotente por 24 h. Ver Idempotencia y sandbox.
x-coffeemail-sandbox
Con true, el envío se valida pero no sale al destinatario.
x-request-id
Vuelve en cada respuesta; compártelo con soporte.
retry-after
Vuelve con 429; segundos hasta poder intentar de nuevo.

Límites

Cada clave tiene un límite de solicitudes por segundo y cada plan una cuota mensual. Pasado el límite, la API responde 429 con RATE_LIMIT_EXCEEDED o PLAN_QUOTA_EXCEEDED.