Autenticación: claves de API
Cómo crear una clave de API de XBASE, elegir los alcances, enviar la clave en las solicitudes, comprobarla con GET /me y revocarla.
Actualizado el
La API usa claves de API del workspace, que empiezan con xsk_. Cada clave tiene un nombre, solo vale en el workspace en el que se creó y solo para los alcances que marques.
Crear la clave
- En XBASE, abre Integraciones y ve a la pestaña Agentes y APIs. Necesitas permiso para gestionar integraciones.
- En la tarjeta Claves de API, haz clic en Nueva clave (o en Conectar integración, si es la primera).
- En Nombre, escribe quién va a usar la clave, como "ERP de la tienda".
- En Permisos, marca solo lo que la integración necesita (alcances).
- Haz clic en Crear clave. La ventana Clave creada muestra la clave completa una sola vez: cópiala y guárdala en un gestor de contraseñas.
- Haz clic en Listo, ya la copié.
Usar la clave
Envía la clave en el encabezado Authorization. Para comprobar que funciona, llama a GET /me:
curl https://api.xbase.app/api/external/v1/me \
-H "Authorization: Bearer $XBASE_API_KEY"Respuesta 200:
{
"workspace": { "id": "8f0c2d4e-…", "name": "Mi empresa" },
"key": { "id": "3b1e9a77-…", "name": "ERP de la tienda", "scopes": ["whatsapp:send"] }
}Guarda la clave en una variable de entorno o en un gestor de secretos, nunca en el código del sitio o de la aplicación.
Revocar y cambiar la clave
En la tarjeta Claves de API, cada clave aparece con los 4 últimos caracteres, la fecha de creación y el último uso. Haz clic en Revocar para cortar el acceso al instante. Revocar también desactiva el webhook de la clave.
Para cambiar una clave sin detener la integración: crea la nueva, actualiza el sistema que la usa y solo entonces revoca la antigua.
Errores de autenticación
| Estado | code | Cuándo |
|---|---|---|
| 401 | INVALID_API_KEY | sin encabezado Authorization, o la clave tiene un formato incorrecto, no existe o fue revocada |
| 403 | MISSING_SCOPE | la clave existe, pero no tiene el alcance de la ruta |
Ejemplo:
{
"statusCode": 401,
"timestamp": "2026-11-04T16:03:56.074Z",
"path": "/api/external/v1/me",
"method": "GET",
"message": "Chave de API inválida ou revogada.",
"code": "INVALID_API_KEY"
}Preguntas frecuentes
Ver también
API de XBASE: visión general
Qué hace la API de XBASE, la dirección base, cómo autenticarse y la lista de endpoints de WhatsApp, Instagram, webhooks y agentes externos.
Webhooks: recibir eventos en tiempo real
Recibe en tu URL, en tiempo real, los eventos de WhatsApp y los comentarios y DM de Instagram, verifica la firma y entiende los reintentos.