Gestione delle chiavi API
Le chiavi sono identificatori univoci utilizzati per l'autenticazione, consentendo a utenti, sviluppatori o ai programmi di accedere in modo sicuro a un'API. Sono essenziali per tracciare e controllare l'utilizzo di API, consentendo di prevenire gli abusi e garantendo una comunicazione sicura.
Utilizzo di chiavi API per connettersi alle API Qlik Cloud
È possibile utilizzare le chiavi API per interagire con l'API REST di riferimento su qlik.dev. Per l'accesso alle API è possibile utilizzare strumenti come Postman o qlik-cli. Per maggiori informazioni, vedere Panoramica delle API Qlik e qlik-cli.
Esempio: utilizzo di Postman per connettersi alle API di Qlik
Procedere come indicato di seguito:
-
Avviare Postman.
-
Impostare il metodo HTTP su GET.
-
Inserire l'URL per l'endpoint dell'API Qlik Cloud.
Ad esempio, per elencare tutti gli spazi nel tenant:
https://your-tenant.eu.qlikcloud.com/api/v1/spaces
-
Nella scheda Auth, scegliere Token bearer come Tipo Auth.
-
Inserire la chiave API nel campo Token.
-
Fare clic su Invia.
Se la richiesta ha esito positivo, l'API restituisce una risposta JSON. In questo esempio, la risposta includerà un elenco di spazi.
Abilitazione delle chiavi API nel tenant
Per impostazione predefinita, la generazione delle chiavi API è disabilitata. Gli amministratori tenant devono abilitare le chiavi API nel tenant per consentire agli utenti di generarle.
Procedere come indicato di seguito:
- Nel centro attività Amministrazione, andare a Impostazioni.
- In Chiavi API, selezionare Abilita chiavi API.
-
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.
- Modifica numero massimo di chiavi API attive per utente: questo limite si applica solo alle nuove chiavi API. Se il limite viene raggiunto, non verrà consentita la creazione di chiavi API aggiuntive. Il valore massimo che è impossibile impostare è 1000.
Nota informaticaPotrebbe essere necessario aggiornare il browser per visualizzare le modifiche riflesse nella sezione Chiavi API nella pagina del proprio profilo utente. -
-
Per avviare la generazione delle chiavi API, fare clic su Genera nuova. Si verrà reindirizzati alla sezione Chiavi API del profilo utente personale.
Generazione e gestione delle chiavi API.
Generazione di chiavi API
Per generare nuove chiavi API, è necessario avere il ruolo Sviluppatore. Gli amministratori tenant possono assegnare questo ruolo agli utenti.
Procedere come indicato di seguito:
-
Fare clic sul proprio profilo utente e selezionare Impostazioni profilo.
-
Nella sezione Chiavi API, fare clic su Genera nuova chiave.
-
Fornire una descrizione e impostare un'ora per la scadenza della chiave API.
-
Fare clic su Genera per creare la chiave.
-
Copiare la chiave API generata e archiviarla in modo sicuro. Notare che non è possibile recuperare la chiave successivamente.
Modifica chiavi API
È possibile cambiare il nome di una chiave API dopo la sua creazione.
Eliminazione di chiavi API
Procedere come indicato di seguito:
-
Fare clic sul proprio profilo utente e selezionare Impostazioni profilo.
-
Andare alla sezione Chiavi API.
-
Fare clic su accanto alla chiave API che si desidera eliminare, quindi selezionare Elimina.
-
Per eliminare tutte le chiavi, fare clic su Elimina tutto nella parte superiore dell'elenco delle chiavi API.
Monitoraggio e revoca delle chiavi API
È possibile visualizzare tutte le chiavi API associate al tenant nella sezione Chiavi API del centro attività Amministrazione. È possibile cercare le chiavi per nome, ID o proprietario.
Stati delle chiavi API
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.
Revoca chiavi API
Se si dispone del ruolo di amministratore tenant, il monitoraggio attivo delle attività della chiave API è essenziale per motivi di sicurezza. Nel caso in cui si rilevino delle attività sospette, è possibile revocare la chiave API.
Procedere come indicato di seguito:
-
Nel centro attività Amministrazione, andare a Eventi.
-
Controllare la presenza di qualsiasi attività sospetta, come l'utilizzo eccessivo di una determinata chiave API.
-
Fare clic su accanto all'evento per espanderne i dettagli e copiare l'ID della chiave API.
-
Andare alla sezione Chiavi API e cercare la chiave API che utilizza quell'ID.
-
Fare clic su accanto alla chiave e selezionare Revoca. È possibile revocare unicamente le chiavi con lo stato Attivo.
-
Per revocare più chiavi API, selezionarle nella tabella e fare clic su Revoca nell'angolo in alto a destra.
Procedure guidate per la gestione delle chiavi API
-
Mantenere la riservatezza delle chiavi: archiviare le chiavi API in modo sicuro ed evitare di esporle in repository di codice pubblici.
-
Rigenera regolarmente: rigenerare periodicamente le chiavi API per migliorare la sicurezza.
-
Monitora l'utilizzo: controllare regolarmente le attività delle chiavi API per identificare eventuali comportamenti sospetti.