Envía a través de la API
Todo lo que hay en el producto está disponible a través de una API REST. Conecta los envíos transaccionales (confirmaciones de pedido, restablecimientos de contraseña, alertas) a tu backend una vez y, después, suscríbete a los webhooks para los eventos de entrega e interacción.
Lo que necesitarás
- Un dominio de envío verificado
- Acceso de administrador para crear una API key
- Un backend que pueda hacer peticiones HTTPS
Crea una API key
- 1
Abre Configuración → API keys → “Crear”
Emite una clave con el alcance exacto que necesita (p. ej. messages:send), con un límite de tasa y una lista de IP permitidas opcional para que una clave filtrada no pueda usarse de forma indebida.
- 2
Copia la clave una sola vez
La clave completa (sb_live_<prefix>.<secret>) solo se muestra al crearla. Guárdala en tu gestor de secretos: no se puede recuperar de nuevo.
Autentícate
Cada petición usa un token Bearer. La URL base es https://api.climails.com/v1.
Authorization: Bearer sb_live_<prefix>.<secret>Envía un mensaje
Haz POST a /v1/messages con un canal, un destinatario y, o bien un template_id (+ variables), o bien subject/html en bruto. Pasa una Idempotency-Key para que una petición reintentada nunca se envíe dos veces.
curl https://api.climails.com/v1/messages \
-H "Authorization: Bearer sb_live_<prefix>.<secret>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: order-1042" \
-d '{
"channel": "email",
"to": "[email protected]",
"from_email": "[email protected]",
"subject": "Your order is confirmed",
"html": "<p>Hi Ann, your order #1042 is on its way.</p>"
}'Pruébalo en el navegador
Abre Configuración → API y Playground para usar la consola interactiva de RapiDoc: pega tu clave en “Authenticate” y ejecuta peticiones reales antes de escribir una sola línea de código. La misma referencia es pública en /docs, y la especificación OpenAPI en bruto en /openapi.yaml.
Suscríbete a los webhooks
Registra un webhook (Configuración → Webhooks, o POST /v1/workspaces/{workspace_id}/webhooks) para recibir eventos de entrega, rebote, reclamación, apertura y clic, de modo que tu aplicación reaccione a lo que ocurre después del envío.
- Los recursos con alcance de espacio de trabajo viven en /v1/workspaces/{workspace_id}/…: obtén tu workspace_id desde GET /v1/workspaces.
- Verifica la firma del webhook usando el secreto que se muestra al crearlo.
Preguntas frecuentes
¿Cuál es la diferencia entre los envíos transaccionales y los de campaña?
Transaccional = un mensaje a una persona disparado por tu aplicación (POST /v1/messages). Las campañas son envíos masivos a listas/segmentos, programados desde el panel o desde la API de campañas.
¿Cómo funciona la idempotencia?
Envía una cabecera Idempotency-Key; una repetición dentro de 24 horas devuelve el resultado original en lugar de enviar de nuevo.
¿Dónde encuentro mi workspace_id?
Llama a GET /v1/workspaces con tu clave: lista el espacio de trabajo al que pertenece la clave.
Empieza a enviar en minutos
Crea una cuenta gratuita, conecta tu dominio y llega a tu audiencia en todos los canales, sin tarjeta de crédito.
Plan gratuito para siempre · Sin tarjeta de crédito · Listo en minutos