Chiavi API - Documentazione di Entity Enricher

Chiavi API

Crea chiavi API per l'accesso programmatico a Entity Enricher. Usa le chiavi di accesso dell'organizzazione per l'integrazione service-to-service, le pipeline CI/CD e i flussi di lavoro automatizzati.

Tipi di chiave

Entity Enricher supporta due tipi di API key, ciascuno adatto a casi d'uso diversi:

Consigliato

Chiavi di accesso dell'organizzazione

Chiavi autonome con un proprio ruolo, non collegate ad alcun account utente. La scelta migliore per l'integrazione servizio-servizio.

  • Hanno un proprio ruolo (owner, editor o operator)
  • Non influenzato dalle modifiche all'account utente
  • Limitato all'organizzazione
  • Richiedi il ruolo di proprietario per la creazione

Chiavi utente legacy

Chiavi associate a un account utente specifico. Ereditano il ruolo del creatore e sono influenzate dalle modifiche all'account utente.

  • Eredita il ruolo dell'utente creatore
  • Se l'utente viene disattivato, la chiave smette di funzionare
  • Qualsiasi utente autenticato può crearne uno

Formato e sicurezza della chiave

Formato:ent_a1b2c3d4e5f6g7h8

Le chiavi utilizzano il prefisso ent_ seguito da byte casuali. La chiave completa viene mostrata una sola volta al momento della creazione — non può essere recuperata in seguito.

Le chiavi di accesso (per chiamare l'API di Entity Enricher) sono archiviate come hash SHA256 nel database, quindi, anche con l'accesso al database, la chiave originale non può essere recuperata. Solo i primi 12 caratteri (il prefisso) sono archiviati in testo normale per l'identificazione.

Le chiavi dei provider (chiavi API LLM come Anthropic, OpenAI) sono cifrate a riposo tramite cifratura simmetrica Fernet (AES-128-CBC + HMAC). Devono essere decifrabili in fase di esecuzione per autenticarsi con i provider LLM. Solo gli ultimi 4 caratteri vengono memorizzati in chiaro.

Creazione chiavi API

Crea chiavi dalla pagina Chiavi API nell'applicazione oppure programmaticamente tramite l'API REST:

Configurazione principale

CampoDescrizione
NomeUn nome descrittivo per l'identificazione (ad es. "Pipeline CI/CD", "Integrazione n8n")
RuoloIl livello di autorizzazione: proprietario, editor o operatore. Determina a cosa può accedere la chiave.
Ambitilettura, scrittura o entrambe. Controlla se la chiave può modificare i dati o solo leggerli.
ScadenzaData di scadenza opzionale. Le chiavi senza scadenza restano valide fino alla revoca.

Utilizzo delle chiavi API

Invia la tua API key nell'intestazione X-API-Key con ogni richiesta:

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

Metodi di autenticazione

MetodoHeaderCaso d'uso
Chiave APIX-API-Key: ent_...Service-to-service, CI/CD, automazione
Bearer TokenAuthorization: Bearer <jwt>Client web, sessioni interattive

Accesso agli endpoint per ruolo

Il ruolo della chiave API determina a quali endpoint può accedere:

Categoria di endpointRuolo minimo
Arricchimento (singolo, batch)Operatore
Record (elenco, dettaglio, eliminazione)Operatore
Schema (lettura)Operatore
Schema (crea, modifica, elimina)Editor
FusioneOperatore
Info providerOperatore
Analisi dei costiOperatore
Gestione delle chiavi APIProprietario
Gestione utentiProprietario

Gestione delle chiavi

La pagina Chiavi API offre una visione completa di tutte le chiavi dell'organizzazione con statistiche di utilizzo:

Visualizza l'utilizzoVisualizza il timestamp dell'ultimo utilizzo e il numero totale di utilizzi per ciascuna chiave
Aggiorna ruoloModifica il ruolo di una chiave di accesso dell'organizzazione (solo proprietario)
RevocaDisabilita definitivamente una chiave. Le chiavi revocate non possono essere riattivate.
ScadenzaLe chiavi in scadenza entro 7 giorni vengono contrassegnate. Le chiavi scadute vengono rifiutate automaticamente.

Chiavi Provider vs. Chiavi di Accesso

La pagina Chiavi API dispone di più schede con scopi diversi:

Chiavi Provider

Le chiavi API dei provider LLM della sua organization (Anthropic, OpenAI, ecc.) per una fatturazione indipendente. Supporta più chiavi per provider con rotazione LRU automatica. Consulti Model e prezzi per il sistema BYOK.

Le chiavi dei provider sono crittografate a riposo tramite crittografia simmetrica Fernet (AES-128-CBC con autenticazione HMAC). Vengono decrittografate solo in fase di esecuzione durante le chiamate all'API dell'LLM. Solo gli ultimi 4 caratteri sono memorizzati in chiaro a scopo di visualizzazione.

Chiavi globali

Chiavi dei provider LLM a livello di sistema gestite dagli amministratori. Usate come fallback quando non è disponibile alcuna chiave dell'organization. Supporta più chiavi per provider con rotazione LRU e disattivazione automatica in caso di errori permanenti.

Chiavi di accesso dell'organizzazione

Chiavi per accedere all'API di Entity Enricher. Utilizzate da sistemi esterni per richiamare in modo programmatico gli endpoint di arricchimento, schema, record e altri. Consultare l'API Reference per la documentazione degli endpoint.

Passaggi successivi