Claves de API - Documentación de Entity Enricher

Claves de API

Cree claves de API para acceso programático a Entity Enricher. Utilice claves de acceso de organización para integraciones de servicio a servicio, canalizaciones CI/CD y flujos de trabajo automatizados.

Tipos de claves

Entity Enricher admite dos tipos de claves de API, cada una adecuada para diferentes casos de uso:

Recomendado

Claves de acceso de la organización

Claves independientes con su propio rol, no vinculadas a ninguna cuenta de usuario. La mejor opción para la integración entre servicios.

  • Tienen su propio rol (owner, editor u operator)
  • No se ve afectado por los cambios en la cuenta de usuario
  • Limitado a la organización
  • Requerir el rol de propietario para crear

Claves de usuario heredadas

Claves vinculadas a una cuenta de usuario específica. Heredan el rol del creador y se ven afectadas por los cambios en la cuenta de usuario.

  • Heredar el rol del usuario creador
  • Si el usuario se desactiva, la clave deja de funcionar
  • Cualquier usuario autenticado puede crear uno

Formato y seguridad de la clave

Formato:ent_a1b2c3d4e5f6g7h8

Las claves usan el prefijo ent_ seguido de bytes aleatorios. La clave completa se muestra solo una vez en el momento de la creación — no se puede recuperar después.

Las claves de acceso (para llamar a la API de Entity Enricher) se almacenan como hashes SHA256 en la base de datos, por lo que, incluso con acceso a la base de datos, no es posible recuperar la clave original. Solo los primeros 12 caracteres (el prefijo) se almacenan en texto plano para su identificación.

Las claves de proveedor (claves de API de LLM como Anthropic, OpenAI) se cifran en reposo mediante cifrado simétrico Fernet (AES-128-CBC + HMAC). Deben poder descifrarse en tiempo de ejecución para autenticarse con los proveedores de LLM. Solo se almacenan los últimos 4 caracteres en texto plano.

Creando claves de API

Cree claves desde la página Claves de API en la aplicación, o mediante programación a través de la API REST:

Configuración de la clave

CampoDescripción
NombreUn nombre descriptivo para su identificación (p. ej., "CI/CD Pipeline", "Integración con n8n")
RolEl nivel de permiso: propietario, editor u operador. Determina a qué puede acceder la clave.
Alcanceslectura, escritura o ambas. Controla si la clave puede modificar datos o solo leerlos.
VencimientoFecha de expiración opcional. Las claves sin expiración duran hasta que se revocan.

Uso de claves API

Envíe su clave de API en la cabecera X-API-Key con cada solicitud:

curl -H "X-API-Key: ent_your_key_here" \
     https://your-instance.example.com/api/enrichment/options

Métodos de autenticación

MétodoEncabezadoCaso de uso
Clave de APIX-API-Key: ent_...Servicio a servicio, CI/CD, automatización
Token BearerAuthorization: Bearer <jwt>Clientes web, sesiones interactivas

Acceso a endpoints por rol

El rol de la clave de API determina a qué endpoints puede acceder:

Categoría de endpointRol mínimo
Enriquecimiento (individual, por lotes)Operador
Registros (listar, detalle, eliminar)Operador
Esquema (lectura)Operador
Esquema (crear, editar, eliminar)Editor
FusiónOperador
Información del proveedorOperador
Análisis de costosOperador
Gestión de claves de APIPropietario
Gestión de usuariosPropietario

Gestión de claves

La página de Claves de API ofrece una vista completa de todas las claves de la organización con estadísticas de uso:

Ver usoVea la marca de tiempo del último uso y el número total de usos de cada clave
Actualizar rolCambiar el rol de una clave de acceso de la organización (solo el propietario)
RevocarDeshabilite permanentemente una clave. Las claves revocadas no se pueden reactivar.
VencimientoLas claves que caducan en un plazo de 7 días se marcan. Las claves caducadas se rechazan automáticamente.

Claves de proveedor frente a claves de acceso

La página de Claves de API tiene varias pestañas con distintos propósitos:

Claves de proveedor

Las claves de API del proveedor de LLM de su organización (Anthropic, OpenAI, etc.) para una facturación independiente. Admite varias claves por proveedor con rotación LRU automática. Consulte Modelos y precios para conocer el sistema BYOK.

Las claves de proveedor se cifran en reposo mediante cifrado simétrico Fernet (AES-128-CBC con autenticación HMAC). Solo se descifran en tiempo de ejecución al realizar llamadas a la API de LLM. Únicamente se almacenan los últimos 4 caracteres en texto plano con fines de visualización.

Claves globales

Claves de proveedores de LLM para todo el sistema gestionadas por los administradores. Se utilizan como alternativa cuando no hay ninguna clave de la organización disponible. Admite varias claves por proveedor con rotación LRU y desactivación automática en caso de fallos permanentes.

Claves de acceso de la organización

Claves para acceder a la propia API de Entity Enricher. Las utilizan sistemas externos para llamar mediante programación a los endpoints de enriquecimiento, esquema, registros y otros. Consulte la Referencia de la API para ver la documentación de los endpoints.

Próximos pasos