Integración
API keys
Llaves para que tus sistemas (ERP, tienda en línea, CRM propio) usen la API: define permisos, limítalas a una instancia, ponles vencimiento y revócalas cuando ya no se usen.
Descripción
Una API key es la contraseña que usa un sistema (no una persona) para hablar con Chat Digital. Se envía en cada petición en el header X-API-Key. Solo los administradores de la cuenta pueden crearlas y revocarlas.
Guía de implementación
- Crea una llave por sistema o proyecto (p. ej. «ERP producción»)
- Dale solo los permisos que necesita y, si puedes, limítala a su instancia
- Cópiala y guárdala en el gestor de secretos o en la configuración del sistema
- Revoca las llaves que ya no se usen
Depende de
Lo usan
Funcionalidades
- Crear llaves con nombre, permisos (scopes) y vencimiento opcional
- Limitar una llave a una sola instancia
- La llave completa se muestra una sola vez, con botón para copiarla
- Ver prefijo, permisos, instancia, estado, último uso y vencimiento
- Revocar una llave de inmediato
Manual de usuario
Crear una API key #
Crea una llave distinta para cada sistema que se integre: así, si una se filtra, solo revocas esa.
- Paso 1: Entra a API keys y haz clic en «Nueva API key»
- Paso 2: Escribe el «Nombre»Algo que diga quién la usa, p. ej. «ERP producción».
- Paso 3: Marca los «Permisos»instances.read (ver instancias y su estado), messages.send (enviar mensajes) y messages.read (consultar mensajes y su estado). Elige al menos uno.
- Paso 4: Opcional: elige una «Instancia»Con «Todas las instancias» la llave sirve para cualquiera; con una instancia, solo para esa.
- Paso 5: Opcional: elige la fecha en «Expira»Vacío = no expira. La fecha debe ser futura.
- Paso 6: Haz clic en «Crear API key»
La llave se muestra una sola vez #
Al crearla aparece la ventana «API key creada» con la llave completa. Por seguridad Chat Digital no la guarda en claro: después solo verás su prefijo.
- Paso 1: Haz clic en «Copiar al portapapeles»
- Paso 2: Pégala en la configuración de tu sistema o en tu gestor de secretos
- Paso 3: Haz clic en «Ya lo guardé»
Estados y revocar una llave #
La columna «Estado» muestra Activa, Expirada o Revocada. «Último uso» te ayuda a detectar llaves que nadie usa.
- Paso 1: Haz clic en «Revocar» en la fila de la llave
- Paso 2: Confirma en «Revocar API key»La llave deja de funcionar de inmediato: los sistemas que la usen recibirán 401. No se puede deshacer.
Relacionado: Integración (API REST)
Preguntas frecuentes
¿Puedo volver a ver una API key que ya creé?
No. Solo se muestra al crearla. Si no la guardaste, revócala y crea otra.
Mi sistema recibe 401 o 403. ¿Qué reviso?
401: la llave es inválida, está revocada o expiró. 403: a la llave le falta el permiso necesario (por ejemplo messages.send) o está limitada a otra instancia.