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 delle chiavi API per connettersi alle API di Qlik Cloud
È possibile utilizzare le chiavi API per interagire con il riferimento API REST di Qlik. Strumenti come Postman o qlik-cli possono essere utilizzati per l'accesso alle API. Per ulteriori informazioni, vedere Panoramica delle API di Qlik e qlik-cli.
Le credenziali API forniscono accesso programmatico diretto a Qlik Cloud e non sono limitate ai flussi di lavoro disponibili nell'interfaccia utente. Assegnare i ruoli e gli ambiti OAuth utilizzando il principio del privilegio minimo. Trattare gli account di servizio e le credenziali API con lo stesso livello di attenzione delle credenziali di amministratore. Per ulteriori informazioni, vedere Controllo degli accessi API e limiti di attendibilità.
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 API di Qlik Cloud.
Ad esempio, per elencare tutti gli spazi nel tenant:
https://your-tenant.eu.qlikcloud.com/api/v1/spaces
-
Nella scheda Auth, scegliere Bearer Token come Auth Type.
-
Inserire la propria chiave API alla voce Token (campo).
-
Fare clic su Send.
Se la richiesta ha esito positivo, l'API restituirà una risposta JSON. In questo esempio, la risposta includerà un elenco di spazi.
Configurazione delle impostazioni delle chiavi API
Procedere come indicato di seguito:
-
Nel centro attività Amministrazione, andare alla pagina Impostazioni.
- Selezionare la scheda Controllo funzionalità.
-
Nella sezione Chiavi API, regolare le seguenti impostazioni in base alle necessità:
-
Modifica scadenza massima token: Impostare il periodo di scadenza per i token API appena generati. Le chiavi API esistenti manterranno il loro valore di scadenza originale. Non esiste un limite massimo per questo valore.
- Modifica numero massimo di chiavi API attive per utente: Impostare il limite per il numero di chiavi API che un utente può avere. Questo limite si applica solo alle nuove chiavi. Se il limite viene raggiunto, gli utenti non saranno in grado di creare chiavi aggiuntive. Il valore massimo è 1000.
-
Potrebbe essere necessario aggiornare il browser per visualizzare le modifiche riflesse nella sezione Chiavi API della pagina delle impostazioni personali.
Generazione e gestione delle chiavi API
Generazione delle chiavi API
Per generare nuove chiavi API, è necessario disporre di un ruolo personalizzato con l'autorizzazione Gestisci chiavi API, oppure l'autorizzazione deve essere abilitata nelle impostazioni Predefinite utente.
Procedere come indicato di seguito:
-
Fare clic sull'icona del proprio profilo utente e selezionare Impostazioni.
-
Andare alla sezione Chiavi API e fare clic su Genera nuova chiave.
-
Fornire una descrizione e impostare un tempo di scadenza per la chiave API.
-
Fare clic su Genera per creare la chiave.
-
Copiare la chiave API generata e conservarla in modo sicuro. Tenere presente che la chiave non potrà essere recuperata in seguito.
Modifica delle chiavi API
È possibile modificare il nome di una chiave API dopo la creazione.
Eliminazione delle chiavi API
Procedere come indicato di seguito:
-
Fare clic sull'icona del proprio profilo utente e selezionare Impostazioni.
-
Andare alla sezione Chiavi API.
-
Fare clic su
accanto alla chiave API che si desidera eliminare e selezionare Elimina.
-
Per rimuovere tutte le chiavi, fare clic su Elimina tutto sopra l'elenco delle chiavi.
Monitoraggio e revoca delle chiavi API
È possibile visualizzare tutte le chiavi API associate al proprio 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:
- Attivo: La chiave API è attualmente in uso.
- Scaduto: La data di scadenza è stata raggiunta.
- Revocato: La chiave API è stata revocata e non può più essere utilizzata.
Revoca delle chiavi API
In qualità di amministratore del tenant, il monitoraggio attivo delle attività delle chiavi API è essenziale per mantenere la sicurezza. Se vengono rilevate attività sospette, è possibile revocare la chiave API.
Procedere come indicato di seguito:
-
Nel centro attività Amministrazione, andare su Eventi.
-
Cercare eventuali attività sospette, come l'uso eccessivo di una particolare 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 utilizzando il suo ID.
-
Fare clic su
accanto alla chiave e selezionare Revoca. È possibile revocare solo le chiavi con stato Attivo.
-
Per revocare più chiavi API, selezionarle nella tabella e fare clic su Revoca nell'angolo in alto a destra.
Best practice per la gestione delle chiavi API
-
Mantenere le chiavi riservate: Conservare le chiavi API in modo sicuro ed evitare di esporle in repository di codice pubblici.
-
Rigenerare regolarmente: Rigenerare periodicamente le chiavi API per migliorare la sicurezza.
-
Monitorare l'utilizzo: Controllare regolarmente le attività delle chiavi API per identificare eventuali comportamenti sospetti.