Clés API - Documentation Entity Enricher

Clés API

Créez des clés API pour un accès programmatique à Entity Enricher. Utilisez les clés d'accès d'organisation pour les intégrations de service à service, les pipelines CI/CD et les workflows automatisés.

Types de clés

Entity Enricher prend en charge deux types de clés API, chacun adapté à des cas d'usage différents :

Recommandé

Clés d'accès de l'organisation

Clés autonomes dotées de leur propre rôle, non liées à un compte utilisateur. Le meilleur choix pour l'intégration de service à service.

  • Disposent de leur propre rôle (propriétaire, éditeur ou opérateur)
  • Non affecté par les modifications du compte utilisateur
  • Limité à l'organisation
  • Exiger le rôle de propriétaire pour créer

Clés utilisateur héritées

Clés liées à un compte utilisateur spécifique. Elles héritent du rôle de leur créateur et sont affectées par les modifications du compte utilisateur.

  • Hériter du rôle de l'utilisateur créateur
  • Si l'utilisateur est désactivé, la clé cesse de fonctionner
  • Tout utilisateur authentifié peut en créer une

Format et sécurité des clés

Format :ent_a1b2c3d4e5f6g7h8

Les clés utilisent le préfixe ent_ suivi d'octets aléatoires. La clé complète n'est affichée qu'une seule fois, à la création — elle ne peut pas être récupérée ultérieurement.

Les clés d'accès (pour appeler l'API d'Entity Enricher) sont stockées sous forme de hachages SHA256 dans la base de données ; ainsi, même avec un accès à la base de données, la clé d'origine ne peut pas être récupérée. Seuls les 12 premiers caractères (le préfixe) sont stockés en clair à des fins d'identification.

Les clés de fournisseur (clés API LLM comme Anthropic, OpenAI) sont chiffrées au repos avec le chiffrement symétrique Fernet (AES-128-CBC + HMAC). Elles doivent pouvoir être déchiffrées à l'exécution pour s'authentifier auprès des fournisseurs LLM. Seuls les 4 derniers caractères sont stockés en clair.

Création des clés API

Créez des clés depuis la page Clés API de l'application, ou par programmation via l'API REST :

Configuration de la clé

ChampDescription
NomUn nom descriptif pour l'identification (p. ex. « Pipeline CI/CD », « Intégration n8n »)
RôleLe niveau de permission : owner, editor ou operator. Détermine ce à quoi la clé peut accéder.
Portéeslecture, écriture, ou les deux. Détermine si la clé peut modifier les données ou seulement les lire.
ExpirationDate d'expiration facultative. Les clés sans expiration restent valides jusqu'à leur révocation.

Utilisation des clés API

Envoyez votre clé API dans l'en-tête X-API-Key avec chaque requête :

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

Méthodes d'authentification

MéthodeEn-têteCas d'usage
Clé APIX-API-Key: ent_...Service à service, CI/CD, automatisation
Jeton BearerAuthorization: Bearer <jwt>Clients web, sessions interactives

Accès aux points de terminaison par rôle

Le rôle de la clé API détermine les points de terminaison auxquels elle peut accéder :

Catégorie de point de terminaisonRôle minimum
Enrichissement (unitaire, traitement par lot)Opérateur
Enregistrements (liste, détail, suppression)Opérateur
Schéma (lecture)Opérateur
Schéma (créer, modifier, supprimer)Éditeur
FusionOpérateur
Informations sur le fournisseurOpérateur
Analyses de coûtsOpérateur
Gestion des clés APIPropriétaire
Gestion des utilisateursPropriétaire

Gestion des clés

La page Clés API offre une vue complète de toutes les clés de l'organisation avec des statistiques d'utilisation :

Voir l'utilisationConsultez l'horodatage de dernière utilisation et le nombre total d'utilisations de chaque clé
Mettre à jour le rôleModifier le rôle d'une clé d'accès d'organisation (propriétaire uniquement)
RévoquerDésactivez définitivement une clé. Les clés révoquées ne peuvent pas être réactivées.
ExpirationLes clés expirant sous 7 jours sont signalées. Les clés expirées sont automatiquement rejetées.

Clés de fournisseur vs. clés d'accès

La page Clés API comporte plusieurs onglets remplissant différentes fonctions :

Clés de fournisseur

Les clés API des providers LLM de votre organisation (Anthropic, OpenAI, etc.) pour une facturation indépendante. Prend en charge plusieurs clés par provider avec rotation LRU automatique. Consultez Modèles et tarifs pour le système BYOK.

Les clés de fournisseur sont chiffrées au repos à l'aide du chiffrement symétrique Fernet (AES-128-CBC avec authentification HMAC). Elles ne sont déchiffrées qu'à l'exécution, lors des appels API LLM. Seuls les 4 derniers caractères sont stockés en clair à des fins d'affichage.

Clés globales

Clés de fournisseurs LLM à l'échelle du système gérées par les administrateurs. Utilisées en repli lorsqu'aucune clé d'organisation n'est disponible. Prend en charge plusieurs clés par fournisseur avec rotation LRU et désactivation automatique en cas d'échecs permanents.

Clés d'accès de l'organisation

Clés d'accès à l'API d'Entity Enricher. Utilisées par des systèmes externes pour appeler par programmation les points de terminaison d'enrichissement, de schéma, d'enregistrements et autres. Consultez la référence API pour la documentation des points de terminaison.

Prochaines étapes