Gestione delle chiavi API

Le chiavi API sono utilizzate come identificatori univoci per l'autenticazione, consentendo a utenti, sviluppatori o ai programmi di accedere in modo sicuro a un'API. Le chiavi API API spesso sono utilizzate per il tracciamento e il controllo dell'utilizzo dell'API per prevenire qualsiasi abuso.

Panoramica sulle chiavi API

Nella sezione Chiavi API della Console di gestione, è possibile visualizzare tutte le chiavi API associate al tenant. È possibile cercare le chiavi per nome, ID o proprietario.

Le chiavi API possono avere i seguenti stati:

• Attiva: la chiave API è attualmente in uso.
• Scaduta: la data di scadenza è stata raggiunta.
• Revocata: la chiave API è stata revocata e non può più essere utilizzata.

Gli amministratori tenant possono abilitare la generazione delle chiavi API, oltre a monitorare e revocare le chiavi API. Per generare, modificare o eliminare le chiavi API, è richiesto il ruolo Sviluppatore. Gli amministratori tenant possono assegnare questo ruolo agli utenti, anche a se stessi.

Abilitazione delle chiavi API nel tenant

Per impostazione predefinita, le chiavi API sono disabilitate. Gli amministratori tenant possono abilitare le chiavi API nel tenant.

Procedere come indicato di seguito:

1. In Console di gestione, andare in Impostazioni.
2. Andare alla sezione Chiavi API e selezionare Abilita chiavi API.
3. Se necessario, regolare le seguenti impostazioni:

   • Modifica scadenza massima token: modifica la scadenza dei token appena generati. Le chiavi API esistenti mantengono il valore di scadenza originale. Non esiste un limite massimo per questo valore.

     Nota informaticaPotrebbe essere necessario aggiornare il browser per visualizzare le modifiche riflesse nella sezione Chiavi API nella pagina del profilo utente.
   • Modifica numero massimo di chiavi API attive per utente: questa impostazione interessa solo le nuove chiavi API. Se il limite viene raggiunto, non verrà consentita la creazione di nuove chiavi API. Il limite massimo per il valore è 1000.

4. Per avviare la generazione delle chiavi API, fare clic su Genera nuova. Questa opzione reindirizza l'utente alla sezione Chiavi API sulla relativa pagina del profilo utente, in cui è possibile creare nuove chiavi.

Generazione di chiavi API

È possibile generare chiavi API dall'hub. Prima di iniziare, assicurarsi che siano soddisfatti i requisiti seguenti:

• Si dispone di una licenza attiva

• L'opzione Abilita chiavi API è attiva nella Console di gestione.
• Si dispone del ruolo Sviluppatore.

Procedere come indicato di seguito:

1. Fare clic sull'icona del proprio profilo utente nell'angolo in alto a destra e selezionare Impostazioni profilo.

2. Nella sezione Chiavi API, fare clic su Genera nuova chiave.

3. Fornire una descrizione e un'ora per la scadenza della chiave API.

4. Fare clic su Genera per creare la chiave.

5. Copiare immediatamente la chiave API generata e archiviarla in modo sicuro. Non è possibile recuperare la chiave successivamente.

Dopo la creazione, sarà possibile modificare il nome della chiave API o eliminarla se necessario.

La chiave API consente di esplorare il riferimento API REST su qlik.dev utilizzando strumenti come Postman, oppure installare qlik-cli per accedere alle funzionalità di Qlik direttamente dalla riga di comando. Per maggiori informazioni, vedere Panoramica delle API Qlik e qlik-cli.

Monitoraggio e revoca delle chiavi API

Se si dispone del ruolo di amministratore tenant, è essenziale monitorare le attività della chiave API per motivi di sicurezza. Nel caso in cui si rilevino delle attività sospette, è possibile revocare la chiave API.

Tenere presente che la revoca di una chiave API la disattiva immediatamente, con impatto sui processi o sulle integrazioni in esecuzione che fanno affidamento su di essa. La revoca è irreversibile e la chiave revocata non può essere riattivata.

Procedere come indicato di seguito:

1. Nella Console di gestione, andare alla sezione Eventi.

2. Controllare la presenza di qualsiasi attività sospetta, come l'utilizzo eccessivo di una determinata chiave API.

3. Fare clic su accanto all'evento per espanderne i dettagli e copiare l'ID della chiave API.

4. Andare alla sezione Chiavi API e cercare la chiave API che utilizza quell'ID.

5. Fare clic su accanto alla chiave e selezionare Revoca. È possibile revocare unicamente le chiavi con lo stato Attivo.

6. Per revocare più chiavi API, selezionarle nella tabella e fare clic su Revoca nell'angolo in alto a destra.

Eliminazione di chiavi API

Quando si eliminano in modo permanente delle chiavi API, queste vengono rimosse dal sistema. L'eliminazione delle chiavi API è irreversibile e ne rimuove in modo immediato tutti i privilegi di accesso. Assicurarsi che questa azione non abbia un impatto negativo su qualsiasi processo o integrazione in esecuzione che faccia affidamento su di essa.

Per eliminare le chiavi API è necessario disporre del ruolo di Sviluppatore.

Procedere come indicato di seguito:

1. Fare clic sull'icona del proprio profilo utente nell'angolo in alto a destra e selezionare Impostazioni profilo.

2. Selezionare la sezione Chiavi API.

3. Fare clic su accanto alla chiave API che si desidera eliminare, quindi selezionare Elimina.

4. Se si desidera eliminare tutte le chiavi, fare clic su Elimina tutto nella parte superiore dell'elenco delle chiavi API.