Chiavi API

Una chiave API consente a un altro programma di utilizzare l'API di AurionAI per la tua organizzazione. Ogni chiave ha un elenco di autorizzazioni, chiamate scope. Una chiave può eseguire solo le operazioni consentite dai suoi scope.

Disponibilità: tutti i profili. Solo gli amministratori.

Prerequisiti

• Hai il ruolo Proprietario o Amministratore. Gli altri utenti visualizzano Accesso negato.
• Sai cosa deve fare il programma, in modo da assegnargli solo gli scope necessari.

Aprire le chiavi API

1. Nella barra laterale, seleziona Configurazione.
2. Apri la categoria Sistema.
3. Seleziona Chiavi API.

La tabella Chiavi attive mostra il nome, l'inizio della chiave, gli scope, lo stato, la data di creazione, l'ultimo utilizzo e la data di scadenza di ogni chiave. Le chiavi revocate sono elencate sotto Chiavi revocate.

Creare una chiave

1. Seleziona Crea chiave.
2. In Nome, digita un nome che indichi quale programma utilizza la chiave.
3. Facoltativo: in Descrizione (facoltativa), descrivi a cosa serve la chiave.
4. In Scadenza, scegli quando scade la chiave. Il valore predefinito è 90 giorni. Puoi anche scegliere Nessuna scadenza.
5. Sotto Autorizzazioni, seleziona gli scope. Una casella di controllo di gruppo seleziona tutti gli scope del gruppo.
6. Seleziona Crea chiave.
7. Copia la chiave con Copia chiave API. AurionAI mostra la chiave completa solo questa volta.
8. Seleziona L'ho copiata — chiudi.

Il programma invia la chiave nell'intestazione X-API-Key di ogni richiesta. Una chiave inizia con itsm_sk_live_, oppure con itsm_sk_test_ per un'organizzazione sandbox.

Scope

Note sugli scope:

• Per pubblicare articoli della knowledge base con immagini, una chiave necessita di kb:read, kb:write e kb:media. Con solo kb:read e kb:write, non è possibile caricare immagini. Non esiste uno scope per eliminare gli articoli.
• Per esportare la trascrizione di una chiamata, una chiave necessita di conversations:read, conversations:write e conversations:export; le chiavi create prima che conversations:export esistesse non possono esportare finché non si crea una chiave sostitutiva che lo include.
• Non esiste uno scope "tutte le autorizzazioni". Seleziona ogni scope di cui il programma ha bisogno.

Ruotare una chiave

Ruota una chiave quando sospetti che qualcun altro la conosca.

1. Nella colonna Azioni della chiave, seleziona Ruota chiave.
2. Nella finestra di dialogo Ruota chiave API, seleziona Ruota chiave.
3. Copia la nuova chiave. La vecchia chiave smette di funzionare. Aggiorna il programma con la nuova chiave.

La nuova chiave mantiene il nome, gli scope e la data di scadenza di quella precedente.

Revocare una chiave

1. Nella colonna Azioni della chiave, seleziona Revoca chiave.
2. Nella finestra di dialogo Revoca chiave API, seleziona Revoca chiave.

Appare il messaggio Chiave API revocata. I programmi che utilizzano la chiave perdono immediatamente l'accesso. Non è possibile annullare questa operazione.

Risultato

Una nuova chiave funziona immediatamente, con i soli scope assegnati. La colonna Stato mostra Attiva, In scadenza negli ultimi sette giorni prima della scadenza, Scaduta o Revocata.

In caso di problemi

• Seleziona almeno un'autorizzazione Seleziona almeno uno scope.
• Creazione della chiave API non riuscita Riprova. Se il problema persiste, contatta il supporto AurionAI. Leggi Ottenere assistenza.
• Segreto non disponibile AurionAI non ha mostrato la chiave. Non utilizzare questa chiave. Revocala e creane una nuova.
• Hai perso la chiave. AurionAI non può mostrarla di nuovo. Ruota la chiave oppure creane una nuova.
• Una richiesta con la chiave viene rifiutata. Alla chiave manca lo scope per questa richiesta, oppure è scaduta o revocata. Controlla le colonne Ambiti e Stato.
• Un programma non riesce a caricare immagini nella knowledge base. Aggiungi kb:media: crea una nuova chiave con kb:read, kb:write e kb:media.

Articoli correlati

• API per sviluppatori: utilizzo e webhook
• Connetti i tuoi strumenti ITSM e CS
• Ottenere assistenza