Authorization: Bearer yol_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Crear una API key
- Entra al Dashboard de Yolani
- Ve a Canales > API de Yolani (o Configuración > API Keys)
- Haz clic en Nueva API key
- Asigna un nombre descriptivo (ej. "Integración n8n") y elige los permisos
- Copia el token: solo se muestra una vez
Disponibilidad:
La API pública está incluida en el plan Escala. Si tienes otro plan y la necesitas, contacta al equipo de Yolani para habilitarla en tu cuenta.
Guarda tu token de forma segura:
El token completo solo se muestra al momento de crearlo. Si lo pierdes, revócalo y crea uno nuevo. Nunca lo publiques en repositorios ni en el frontend de tu aplicación.
Permisos (scopes)
Cada API key puede tener acceso completo o permisos específicos:
| Scope | Permite |
|---|---|
contacts:read | Listar y consultar contactos |
contacts:write | Crear y actualizar contactos (incluye lectura) |
conversations:read | Listar conversaciones y sus mensajes |
conversations:write | Abrir conversaciones nuevas (incluye lectura) |
messages:send | Enviar mensajes |
bot:manage | Activar o pausar el agente IA |
Si una key no tiene el scope necesario, la API responde 403 con código INSUFFICIENT_SCOPE.
Verificar tu API key
El endpoint /v1/me sirve para probar la autenticación:
curl https://api.yolani.co/api/v1/me \
-H "Authorization: Bearer yol_TU_TOKEN"
Respuesta:
{
"success": true,
"data": {
"company": { "id": 12, "name": "Mi Empresa" },
"api_key": {
"name": "Integración n8n",
"prefix": "yol_abcdefgh",
"scopes": ["messages:send", "conversations:read"]
}
}
}
Errores de autenticación
| HTTP | Código | Motivo |
|---|---|---|
| 401 | MISSING_API_KEY | Falta el header Authorization: Bearer ... |
| 401 | INVALID_API_KEY | Token inválido, revocado o expirado |
| 403 | MODULE_NOT_ENABLED | Tu plan no incluye la API pública |
| 403 | INSUFFICIENT_SCOPE | La key no tiene el permiso requerido |
Revocar una key
Desde Configuración > API Keys puedes revocar cualquier token. La revocación es inmediata e irreversible.