Skip to main content
Esta guía es tu primera carta en el correo: en unos pocos pasos pasas de la cuenta a tu primer HTTP 202, confirmación de que Notifique recibió tu envío.

¿Qué es esta guía?

Es el camino más corto desde la cuenta hasta el primer envío. Documentación por desarrolladores, para desarrolladores: directa, sin jerga legal. Notifique es la infraestructura de mensajería de tu producto. Las colas, los reintentos y los protocolos permanecen de nuestro lado; obtienes una API REST predecible.

¿Qué lograrás?

Al final de esta guía:
  • Cuenta creada en el panel
  • API Key guardada (sk_test_ o sk_live_)
  • Primer mensaje en cola en SMS o WhatsApp

¿Por dónde empezar?

Para tu primer envío, SMS o WhatsApp suele ser la ruta más corta: Otros canales (correo electrónico, push, Telegram) tienen sus propios inicios rápidos cuando los necesites.

Paso a paso

1. Crea tu cuenta

Crea tu cuenta en el Panel Completa la incorporación para obtener acceso completo a tu Workspace.

2. Crea una API Key

En el panel, abre Developer → API Keys. Ponle un nombre, selecciona scopes para el canal que probarás y cópiala de inmediato.
Las claves comienzan con sk_live_... o sk_test_.... Después de cerrar el modal, no volvemos a mostrar el valor completo. Guárdala en .env o en el administrador de secretos de tu proyecto.
  • Producción (sk_live_...): envíos reales, usa créditos, el mensaje puede llegar a un teléfono real
  • Sandbox (sk_test_...): mismos endpoints, sin entrega real. Revisa Developer → Bandeja de entrada Sandbox
Recomendamos comenzar con sk_test_.... Más información en Sandbox y API Keys.

3. Envía tu primer mensaje

Reemplaza YOUR_API_KEY con la clave que generaste.

SMS

Usa tu número en formato internacional (por ejemplo, 5511999999999). El texto del mensaje debe tener entre 9 y 160 caracteres.
Respuesta esperada: HTTP 202 con el mensaje en cola. Con sk_live_, va al operador. Con sk_test_, abre Developer → Bandeja de entrada Sandbox para ver el envío simulado. Guía completa: Inicio rápido SMS.

WhatsApp

Necesitas una Instance emparejada y los scopes whatsapp:instances:create, whatsapp:instances:list y whatsapp:send. Crea la Instance y obtén el QR
En la respuesta, usa connection.base64 para mostrar el QR y escanéalo en tu teléfono. Cuando el estado es ACTIVE, anota instance.id. Enviar texto
Respuesta esperada: HTTP 202. Con sk_live_ y una Instance activa, el mensaje pasa a WhatsApp. Con sk_test_, revisa Developer → Bandeja de entrada Sandbox. Guía completa: Inicio rápido WhatsApp.

¿Listo?

Si obtuviste HTTP 202, la integración básica funciona. La carta salió de tu sistema y entró en la cola de Notifique.

Próximos pasos

  • API Keys: scopes, mejores prácticas y rotación de claves
  • Sandbox: prueba de forma segura antes de la puesta en marcha
  • Webhooks: recibe alertas de entrega en tu servidor
  • Logs: depura llamadas a la API