Claves de API
Las claves de API dan a los sistemas externos permiso para interactuar con EZY Integrations sin una sesión de usuario. Úsalas cuando otra aplicación necesite disparar una ejecución de trabajo o entregar datos a través de un webhook entrante. Cada clave está limitada a un tenant y debe tratarse como un secreto sensible.
Formato de la Clave
Sección titulada «Formato de la Clave»Cada clave de API sigue este formato:
ezy_{tenantId}_{64hex}Por ejemplo: ezy_<tenantId>_<cadena hexadecimal de 64 caracteres>
El valor completo de la clave se muestra solo una vez, inmediatamente después de crearla. Cópiala a un almacén de secretos seguro antes de cerrar el diálogo — no podrá recuperarse después.
En la vista de lista, la clave solo se muestra como un prefijo corto (por ejemplo, ezy_abc1…) para que puedas identificar cuál es cuál sin exponer el secreto.
Acceder a la Página de Claves de API
Sección titulada «Acceder a la Página de Claves de API»Navega a Claves de API en la barra lateral izquierda. Si tu cuenta es Platform Admin puedes ver las claves de todos los tenants usando el selector de tenants en la parte superior de la página. Los Users regulares solo ven las claves de su tenant asignado.
Crear una Clave de API
Sección titulada «Crear una Clave de API»- Selecciona el tenant destino desde el selector de tenants (solo Platform Admins — los Users regulares omiten este paso).
- Haz clic en Crear Clave.
- Ingresa un Nombre de Clave que describa su propósito (por ejemplo, Sincronización nocturna ERP o Receptor de webhook).
- Selecciona el Rol para la clave:
- API User — Acceso estándar para disparar trabajos y entregar datos. Este es el valor predeterminado para claves con alcance de tenant.
- Admin — Acceso elevado. Disponible solo para el tenant del sistema; las claves de tenant siempre se crean con el rol API User.
- Haz clic en Crear.
- Copia el valor completo de la clave desde el diálogo que aparece. Esta es la única vez que el valor completo se muestra.
Listado de Claves de API
Sección titulada «Listado de Claves de API»La tabla de la lista muestra las siguientes columnas:
| Columna | Descripción |
|---|---|
| Nombre | La etiqueta que asignaste a la clave. |
| Prefijo de clave | Los primeros caracteres de la clave, para identificación. |
| Rol | API User o Admin. |
| Estado | Activa o Revocada. |
| Creado | Fecha en que se creó la clave. |
| Vence | Fecha de vencimiento si se estableció una, o en blanco si no vence. |
Para ver las claves revocadas junto con las activas, marca la casilla Mostrar revocadas sobre la tabla.
Revocar una Clave de API
Sección titulada «Revocar una Clave de API»- En la lista de Claves de API, haz clic en Revocar en la fila que deseas deshabilitar.
- Confirma la acción en el diálogo.
La revocación es inmediata y permanente. Una clave revocada no puede reinstaurarse — crea una nueva clave si necesitas restaurar el acceso.
Usar una Clave de API en Solicitudes
Sección titulada «Usar una Clave de API en Solicitudes»Pasa la clave de API en el encabezado de solicitud X-Api-Key:
X-Api-Key: ezy_<tenantId>_<64hex>Para detalles completos de autenticación y endpoints disponibles, consulta la Referencia de API.
Guía de Seguridad
Sección titulada «Guía de Seguridad»- Almacena las claves de API en un gestor de secretos (por ejemplo, AWS Secrets Manager, Azure Key Vault o HashiCorp Vault). Nunca incluyas claves en código fuente ni en archivos de configuración.
- Crea una clave por integración o sistema externo. Usar claves separadas facilita revocar el acceso a un consumidor sin afectar a los demás.
- Revoca cualquier clave de inmediato si puede haber sido expuesta o comprometida.
- Revisa la lista de claves periódicamente y revoca las claves que ya no estén en uso.
Páginas Relacionadas
Sección titulada «Páginas Relacionadas»- Configuración de Tenant — Cuándo crear claves de API en la secuencia de configuración.
- Credenciales y Secretos — Secretos de perfiles de conexión (distintos de las claves de API).
- Referencia de API — Referencia completa de endpoints y autenticación.