Claves de API y ámbitos
Una clave de API permite a un script u otro sistema llamar a la API de xEvolve sin iniciar sesión en la consola. Cada clave lleva ámbitos que limitan lo que puede hacer.
Crear una clave
- Abre Claves de API y elige Nueva clave.
- Escribe un nombre, marca los ámbitos necesarios y, si quieres, fija una caducidad en días.
- Copia la clave. Empieza por
xev_y solo se muestra una vez. xEvolve guarda únicamente un hash.
Envía la clave como token bearer a tu espacio:
curl https://<workspace>.xevolve.io/api/v1/connections \
-H "Authorization: Bearer xev_<key>"Revocar una clave surte efecto de inmediato. La creación y la revocación de claves se escriben en el registro de auditoría.
Reglas
- Una clave solo puede crear claves cuyos ámbitos estén entre los suyos. Pedir más devuelve 403.
- Una llamada sin el ámbito requerido devuelve 403 con
API key missing required scope. - Una sesión de consola no está limitada por ámbitos; sigue el rol del usuario.
- Los ajustes de autenticación multifactor, la gestión de sesiones, los eventos de inicio de sesión, el registro de principales de servicio, los avatares, la política de retención y el estado de la prueba solo aceptan sesiones de consola. Las claves de API reciben 403.
Ámbitos
| Ámbito | Permite |
|---|---|
files:read | Listar, buscar y descargar archivos. |
files:write | Subir archivos. |
transfers:read | Listar y ver transferencias. |
transfers:write | Crear, ejecutar y cancelar transferencias. |
connections:read | Listar y ver conexiones. |
connections:write | Crear, editar, eliminar y probar conexiones. |
data-rooms:read | Listar y ver salas de datos. |
data-rooms:write | Crear, editar y gestionar salas de datos. |
schedules:read | Listar programaciones y el historial de ejecuciones. |
schedules:write | Crear, editar, eliminar y ejecutar programaciones. |
watchers:read | Listar vigilancias de carpetas. |
watchers:write | Crear, editar y eliminar vigilancias. |
workflows:read | Listar workflows y el historial de ejecuciones. |
workflows:write | Crear, editar, eliminar y ejecutar workflows. |
parameters:read | Listar y ver parámetros globales. |
parameters:write | Crear, editar y eliminar parámetros globales. |
users:read | Listar y ver usuarios. |
users:write | Editar y eliminar usuarios. |
agents:read | Listar y ver agentes gestionados. |
agents:write | Crear, editar, eliminar y probar agentes gestionados. |
webhooks:read | Listar webhooks y entregas. |
webhooks:write | Crear, editar y eliminar webhooks. |
activity:read | Leer el registro de actividad y los contadores del panel. |
notifications:read | Leer los ajustes de notificación y el registro de notificaciones. |
notifications:write | Editar o probar los ajustes de notificación. |
api-keys:read | Listar claves de API. |
api-keys:write | Crear y revocar claves de API, dentro de los ámbitos que tiene la clave que llama. |
Las claves de API y los webhooks requieren el plan Team o superior. Planes y límites indica las solicitudes de API permitidas al mes.