Salta ai contenuti

Autenticazione e chiavi API

Crea una chiave API sk_ nel Centro API . La chiave completa viene mostrata solo una volta, al momento della creazione o della rotazione.

Utilizza una chiave separata per ogni applicazione, ambiente e attività automatizzata, in modo che ciascuna possa avere il proprio budget ed essere disabilitata, rotata e sottoposta a audit indipendentemente.

Consigliato:

X-API-Key: sk_your_key

Anche la forma standard Bearer funziona:

Authorization: Bearer sk_your_key

Invia solo uno dei due in una richiesta.

Terminal window
curl https://omnidoc.top/api/v1/jobs \
-H "X-API-Key: $OMNIDOC_API_KEY"

Una chiave opera per l’account che l’ha creata: può chiamare i servizi utilizzabili da tale account e accedere esclusivamente alle risorse di quell’account. Una chiave non può modificare l’email di accesso, la password, il numero di telefono o il profilo, né può creare, ruotare o revocare chiavi API.

Limiti opzionali:

  • allowed_engines: solo le impostazioni di traduzione elencate; un array vuoto non aggiunge alcun limite a livello di chiave.
  • expires_at: orario di scadenza.
  • quota_limit: il budget di durata della chiave espresso in millicrediti interi; 0 non definisce alcun budget a livello di chiave e i crediti dell’account vengono regolati come di consueto.

Crea chiavi, modifica i loro limiti, ruotale o revocatele nel centro API . Una volta che una chiave viene revocata, disabilitata o scaduta, oppure il relativo account viene disabilitato, le nuove richieste falliscono immediatamente.

La rotazione crea un nuovo segreto e disabilita immediatamente quello vecchio; la nuova chiave mantiene i limiti originali e il budget già utilizzato. Una chiave scaduta non può essere ruotata; è necessario crearne una nuova. Per garantire un passaggio senza interruzioni, creare una nuova chiave e distribuirla, verificare che le chiamate abbiano esito positivo, quindi revocare la chiave precedente.

  • Conserva le chiavi esclusivamente sul server o in un ambiente di runtime controllato.
  • Utilizza le variabili d’ambiente o un gestore dei secret; non inserire mai le chiavi nel codice sorgente, nei log, nei bundle del browser o nei repository pubblici.
  • Non inviare mai la chiave agli indirizzi di upload o download restituiti dall’API.
  • Registra l’ID chiave, l’ID richiesta e l’ID operazione; non registrare mai la chiave completa.
  • Se una chiave viene compromessa, ruotala immediatamente e verifica i relativi lavori e addebiti.