API-Schlüssel - Entity Enricher-Dokumentation

API-Schlüssel

Erstellen Sie API-Schlüssel für den programmatischen Zugriff auf Entity Enricher. Verwenden Sie Organisationszugriffsschlüssel für Service-zu-Service-Integration, CI/CD-Pipelines und automatisierte Workflows.

Schlüsseltypen

Entity Enricher unterstützt zwei Arten von API-Schlüsseln, die jeweils für unterschiedliche Anwendungsfälle geeignet sind:

Empfohlen

Zugriffsschlüssel der Organisation

Eigenständige Schlüssel mit eigener Rolle, die an kein Benutzerkonto gebunden sind. Die beste Wahl für die Service-zu-Service-Integration.

  • Haben eine eigene Rolle (Eigentümer, Bearbeiter oder Operator)
  • Nicht von Änderungen am Benutzerkonto betroffen
  • Auf die Organisation beschränkt
  • Eigentümerrolle zum Erstellen erforderlich

Legacy-Benutzerschlüssel

Schlüssel, die an ein bestimmtes Benutzerkonto gebunden sind. Sie erben die Rolle des Erstellers und sind von Änderungen am Benutzerkonto betroffen.

  • Rolle des erstellenden Benutzers übernehmen
  • Wenn der Benutzer deaktiviert ist, funktioniert der Schlüssel nicht mehr
  • Jeder authentifizierte Benutzer kann einen erstellen

Schlüsselformat & Sicherheit

Format:ent_a1b2c3d4e5f6g7h8

Schlüssel verwenden das Präfix ent_ gefolgt von zufälligen Bytes. Der vollständige Schlüssel wird nur einmal bei der Erstellung angezeigt – er kann später nicht mehr abgerufen werden.

Zugriffsschlüssel (zum Aufrufen der API von Entity Enricher) werden als SHA256-Hashes in der Datenbank gespeichert, sodass der ursprüngliche Schlüssel selbst mit Datenbankzugriff nicht wiederhergestellt werden kann. Nur die ersten 12 Zeichen (das Präfix) werden zur Identifizierung im Klartext gespeichert.

Anbieterschlüssel (LLM-API-Schlüssel wie Anthropic, OpenAI) werden im Ruhezustand mit symmetrischer Fernet-Verschlüsselung (AES-128-CBC + HMAC) verschlüsselt. Sie müssen zur Laufzeit entschlüsselbar sein, um sich bei LLM-Anbietern zu authentifizieren. Nur die letzten 4 Zeichen werden im Klartext gespeichert.

API-Schlüssel werden erstellt

Erstellen Sie Schlüssel über die Seite „API-Schlüssel“ in der Anwendung oder programmatisch über die REST-API:

Wichtige Konfiguration

FeldBeschreibung
NameEin beschreibender Name zur Identifikation (z. B. „CI/CD-Pipeline“, „n8n-Integration“)
RolleDie Berechtigungsstufe: Inhaber, Bearbeiter oder Operator. Bestimmt, worauf der Schlüssel zugreifen kann.
Geltungsbereichelesen, schreiben oder beides. Legt fest, ob der Schlüssel Daten ändern oder nur lesen kann.
AblaufOptionales Ablaufdatum. Schlüssel ohne Ablaufdatum bleiben bis zum Widerruf gültig.

API-Schlüssel verwenden

Senden Sie Ihren API-Schlüssel bei jeder Anfrage im X-API-Key-Header:

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

Authentifizierungsmethoden

MethodeHeaderAnwendungsfall
API-SchlüsselX-API-Key: ent_...Service-zu-Service, CI/CD, Automatisierung
Bearer TokenAuthorization: Bearer <jwt>Web-Clients, interaktive Sitzungen

Endpunktzugriff nach Rolle

Die Rolle des API-Schlüssels bestimmt, auf welche Endpunkte er zugreifen kann:

EndpunktkategorieMindestrolle
Anreicherung (einzeln, Batch)Operator
Datensätze (Liste, Detail, Löschen)Operator
Schema (lesen)Operator
Schema (erstellen, bearbeiten, löschen)Editor
FusionOperator
Provider-InfoOperator
KostenanalysenOperator
API-SchlüsselverwaltungOwner
BenutzerverwaltungOwner

Schlüssel verwalten

Die Seite „API-Schlüssel“ bietet eine vollständige Übersicht aller Schlüssel der Organisation mit Nutzungsstatistiken:

Nutzung anzeigenZeitstempel der letzten Verwendung und Gesamtnutzungszahl für jeden Schlüssel anzeigen
Rolle aktualisierenDie Rolle eines Organisationszugriffsschlüssels ändern (nur Eigentümer)
WiderrufenEinen Schlüssel dauerhaft deaktivieren. Widerrufene Schlüssel können nicht reaktiviert werden.
AblaufSchlüssel, die innerhalb von 7 Tagen ablaufen, werden markiert. Abgelaufene Schlüssel werden automatisch abgelehnt.

Provider-Schlüssel vs. Zugangsschlüssel

Die Seite „API-Schlüssel“ hat mehrere Tabs mit unterschiedlichen Zwecken:

Provider-Schlüssel

Die LLM-Provider-API-Schlüssel Ihrer Organisation (Anthropic, OpenAI usw.) für eine unabhängige Abrechnung. Unterstützt mehrere Schlüssel pro Provider mit automatischer LRU-Rotation. Siehe Modelle & Preise für das BYOK-System.

Provider-Schlüssel werden im Ruhezustand mit symmetrischer Fernet-Verschlüsselung (AES-128-CBC mit HMAC-Authentifizierung) verschlüsselt. Sie werden nur zur Laufzeit bei LLM-API-Aufrufen entschlüsselt. Nur die letzten 4 Zeichen werden zu Anzeigezwecken im Klartext gespeichert.

Globale Schlüssel

Systemweite LLM-Provider-Schlüssel, die von Administratoren verwaltet werden. Werden als Fallback verwendet, wenn kein Organisationsschlüssel verfügbar ist. Unterstützt mehrere Schlüssel pro Provider mit LRU-Rotation und automatischer Deaktivierung bei dauerhaften Fehlern.

Zugriffsschlüssel der Organisation

Schlüssel für den Zugriff auf die eigene API von Entity Enricher. Werden von externen Systemen verwendet, um die Endpunkte für Anreicherung, Schema, Datensätze und weitere programmgesteuert aufzurufen. Siehe die API Reference für die Endpunkt-Dokumentation.

Nächste Schritte