Saltar al contenido principal
Una clave API es la tarjeta de acceso de su sistema a Notifique. Sin ella a pedido, la puerta no se abrirá.

​
¿Qué es una clave API?

Es la credencial que identifica quién llama a la API y a qué espacio de trabajo pertenece. Piense en una tarjeta de acceso a un edificio: no necesita nombre de usuario ni contraseña en cada solicitud, simplemente presente la tarjeta en el encabezado. Cada clave comienza con sk_live_... (producción) o sk_test_... (sandbox).

​
¿Para qué sirve?

La clave conecta su código con Notifique. Con ella podrás:
  • Enviar mensajes (WhatsApp, SMS, correo electrónico, push y otros canales)
  • Consultar historial, estado y mensajes entrantes
  • Administrar instancias, plantillas, contactos y automatizaciones (según los ámbitos seleccionados)
Todo sin una sesión de usuario del panel. Su servidor de aplicaciones se comunica directamente con la API.

​
¿Por qué utilizar claves independientes?

Como darle a cada empleado su propia tarjeta: si uno pierde la suya, cancelas solo esa tarjeta.

​
Qué puedes hacer en el panel

En Desarrollador → Claves API, administras las tarjetas de acceso al espacio de trabajo:
  • Ver qué integraciones ya tienen una clave activa
  • Crear una nueva clave con un nombre y permisos
  • Revocar una clave comprometida sin afectar a las demás
  • Rotar el acceso: una clave por aplicación, servicio o entorno
Cada clave pertenece a un espacio de trabajo (la carpeta de su cliente en el sistema) y define lo que esa integración puede hacer.

​
Sandbox vs producción

Mismo edificio, diferentes puertas:
  • Sandbox (sk_test_...): simulador de vuelo. Pruebas el viaje completo, pero en realidad no se entrega nada. Verifique los envíos en Desarrollador → Bandeja de entrada de Sandbox
  • Producción (sk_live_...): vuelo real. El mensaje sale y se utilizan los créditos.
Más información sobre sandbox →

​
Cómo crear una clave

Las claves se crean en el panel. No puedes crearlas a través de la API pública:
  1. Abra Desarrollador → Claves API
  2. Haga clic en Crear clave
  3. Asígnela un nombre y seleccione los ámbitos: las puertas que esta clave puede abrir
  4. Cópiela de inmediato. Comienza con sk_live_... o sk_test_...
La clave completa se muestra solo una vez, como el PIN de una tarjeta nueva. ¿La perdiste? Crea otra. No podemos recuperarla.

​
Cómo utilizar en tu integración

En cada llamada API, presente la tarjeta en el encabezado Authorization: También aceptamos x-api-key en lugar de Authorization. El recorrido completo está en Empiece aquí.

​
Buenas prácticas

  1. Nunca deje la clave en código público. Guárdela en .env, como la contraseña del Wi‑Fi de la oficina
  2. Una clave por integración. Si la app de prueba se filtra, producción sigue segura
  3. ¿Se filtró? Revóquela en Desarrollador → Claves API y emita una nueva de inmediato
Más detalles: Seguridad y confiabilidad.

​
Ámbitos y permisos

Los ámbitos son las puertas que abre cada clave. Seleccione solo lo que su integración necesita. No entregue la llave maestra si solo envía SMS. Elija el canal que integrará y vea la lista completa de permisos:

WhatsApp

Enviar, conectar número, grupos

SMS

Enviar, consultar, cancelar

Telegram

Enviar, conectar bot, leer mensajes

Instagram

Enviar, responder comentarios

Email

Enviar, configurar dominio

Push

Enviar, administrar apps

RCS

Enviar, consultar, cancelar

Voice

Llamar, controlar, grabar

Templates

Crear plantillas y enviar

Contactos y audiencia

Contactos, etiquetas, campañas

Automatizaciones

Flujos y eventos

Enlaces cortos

Enlaces y conversiones

Números virtuales

Consultar y configurar

Complementos de marketing

Formularios e integraciones
¿Puerta cerrada? Consulte Respuestas de error.

​
Catálogo de canales (GET /v1/meta/channels)

La plataforma expone 9 canales oficiales en la API v1: WhatsApp, Instagram, SMS, Telegram, E-mail, Push, RCS, Voz y Chat (API en tiempo real en su app — vea Introducción al Chat). El noveno canal no es el widget Chat en el sitio: ese widget es un addon de IA para visitantes anónimos. Chat API (/v1/chat/*) es chat 1:1 y grupos con usuarios autenticados en su producto. GET /v1/meta/channels devuelve el catálogo con capabilities y legacy por canal. En whatsapp, capabilities.whatsapp incluye whatsapp_call: las llamadas son capacidad del WhatsApp, no un canal aparte (hoy solo en conexión no oficial). Notify (POST /v1/notify) hace cascada en 8 canales de envío — sin Chat.

​
Rate limit de la API v1

Cada workspace tiene un límite de solicitudes por minuto según el plan (X-RateLimit-Limit). Los valores vienen de PLAN_LIMITS[plan].rateLimitPerMin en el backend. Al superarlo, la API devuelve 429 con RATE_LIMIT_EXCEEDED y Retry-After. Excepciones: GET /v1/*/instances y rutas sync/connect no cuentan en el límite.

​
Próximos pasos

  • Empiece aquí: envíe su primer mensaje
  • Webhooks: reciba alertas en su servidor, como una notificación push