API-sleutels - Entity Enricher-documentatie

API-sleutels

Maak API-sleutels aan voor programmatische toegang tot Entity Enricher. Gebruik organization-toegangssleutels voor service-naar-service-integratie, CI/CD-pipelines en geautomatiseerde workflows.

Sleuteltypes

Entity Enricher ondersteunt twee soorten API-sleutels, elk geschikt voor verschillende gebruikssituaties:

Aanbevolen

Toegangssleutels organisatie

Losstaande sleutels met hun eigen rol, niet gekoppeld aan een gebruikersaccount. De beste keuze voor service-tot-service-integratie.

  • Hebben hun eigen rol (eigenaar, editor of operator)
  • Niet beïnvloed door wijzigingen in gebruikersaccounts
  • Beperkt tot de organisatie
  • Eigenaarsrol vereist om aan te maken

Legacy gebruikerssleutels

Sleutels die gekoppeld zijn aan een specifiek gebruikersaccount. Ze erven de rol van de maker en worden beïnvloed door wijzigingen in het gebruikersaccount.

  • De rol van de aanmakende gebruiker overnemen
  • Als de gebruiker gedeactiveerd is, werkt de sleutel niet meer
  • Elke geverifieerde gebruiker kan er een aanmaken

Sleutelformaat en beveiliging

Formaat:ent_a1b2c3d4e5f6g7h8

Sleutels gebruiken het voorvoegsel ent_ gevolgd door willekeurige bytes. De volledige sleutel wordt slechts één keer getoond bij het aanmaken — deze kan later niet worden opgehaald.

Toegangssleutels (voor het aanroepen van de API van Entity Enricher) worden als SHA256-hashes in de database opgeslagen, dus zelfs met databasetoegang kan de originele sleutel niet worden hersteld. Alleen de eerste 12 tekens (de prefix) worden ter identificatie in platte tekst opgeslagen.

Providersleutels (LLM API-sleutels zoals Anthropic, OpenAI) worden in rust versleuteld met Fernet symmetrische encryptie (AES-128-CBC + HMAC). Ze moeten tijdens runtime te ontsleutelen zijn om te authenticeren bij LLM-providers. Alleen de laatste 4 tekens worden als platte tekst opgeslagen.

API-sleutels aanmaken

Maak sleutels aan op de pagina API-sleutels in de applicatie, of programmatisch via de REST API:

Belangrijke configuratie

VeldBeschrijving
NaamEen beschrijvende naam ter identificatie (bijv. "CI/CD Pipeline", "n8n-integratie")
RolHet machtigingsniveau: owner, editor of operator. Bepaalt waar de sleutel toegang toe heeft.
Bereikenread, write of beide. Bepaalt of de sleutel gegevens kan wijzigen of alleen kan lezen.
VervaldatumOptionele vervaldatum. Sleutels zonder vervaldatum blijven geldig tot ze worden ingetrokken.

API Keys gebruiken

Stuur je API-sleutel bij elk verzoek mee in de X-API-Key-header:

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

Authenticatiemethoden

MethodeHeaderUse case
API-sleutelX-API-Key: ent_...Service-naar-service, CI/CD, automatisering
Bearer-tokenAuthorization: Bearer <jwt>Webclients, interactieve sessies

Endpoint-toegang per rol

De rol van de API-sleutel bepaalt tot welke endpoints hij toegang heeft:

Endpoint-categorieMinimale rol
Verrijking (enkel, batch)Operator
Records (lijst, detail, verwijderen)Operator
Schema (lezen)Operator
Schema (aanmaken, bewerken, verwijderen)Editor
FusieOperator
ProviderinfoOperator
KostenanalysesOperator
Beheer van API-sleutelsEigenaar
GebruikersbeheerEigenaar

Sleutels beheren

De pagina API-sleutels biedt een volledig overzicht van alle sleutels van de organisatie met gebruiksstatistieken:

Bekijk gebruikBekijk de laatst gebruikte tijdstempel en het totale aantal keer gebruik voor elke sleutel
Rol bijwerkenDe rol van een organisatietoegangssleutel wijzigen (alleen eigenaar)
IntrekkenSchakel een sleutel permanent uit. Ingetrokken sleutels kunnen niet opnieuw worden geactiveerd.
VervaldatumSleutels die binnen 7 dagen verlopen, worden gemarkeerd. Verlopen sleutels worden automatisch geweigerd.

Providersleutels versus toegangssleutels

De pagina API-sleutels heeft meerdere tabbladen met verschillende doeleinden:

Providersleutels

De API-keys van de LLM-providers van je organisatie (Anthropic, OpenAI, enz.) voor onafhankelijke facturatie. Ondersteunt meerdere keys per provider met automatische LRU-rotatie. Zie Models & Pricing voor het BYOK-systeem.

Providersleutels worden in rust versleuteld met symmetrische Fernet-encryptie (AES-128-CBC met HMAC-authenticatie). Ze worden alleen tijdens runtime ontsleuteld wanneer er LLM-API-aanroepen worden gedaan. Alleen de laatste 4 tekens worden als platte tekst opgeslagen voor weergavedoeleinden.

Globale sleutels

Platformbrede LLM-providersleutels beheerd door beheerders. Gebruikt als fallback wanneer er geen organization-sleutel beschikbaar is. Ondersteunt meerdere sleutels per provider met LRU-rotatie en automatische uitschakeling bij permanente storingen.

Toegangssleutels organisatie

Sleutels voor toegang tot de eigen API van Entity Enricher. Worden gebruikt door externe systemen om de verrijkings-, schema-, records- en andere endpoints programmatisch aan te roepen. Zie de API-referentie voor endpointdocumentatie.

Volgende stappen