Piattaforma: Chiavi API

Le chiavi API sono una semplice stringa crittografata che può essere utilizzata per generare un token bearer, che a sua volta verrà utilizzato per chiamare le API delle App GW relative al tuo dominio. Assicurati di tenere tutte le tue chiavi al sicuro. Esporre pubblicamente le tue credenziali può portare alla compromissione dei tuoi dati.

Chiavi API della piattaforma

Articolo	Descrizione
+ Crea chiave API	Clicca su per creare una chiave API e seleziona gli ambiti per Utenti e ruoli condivisi.
Abilitato	Consente di abilitare o disabilitare la chiave API specifica. Quando è disabilitata, le richieste che utilizzano tale chiave verranno ignorate da GW Apps.
	Seleziona i tre puntini per visualizzare le opzioni relative alla chiave selezionata.
	– Genera Nuova Chiave genererà una nuova chiave API. Ciò invaliderà la chiave precedente, pertanto dovrai condividere la nuova chiave con gli sviluppatori dei servizi che accedono a questa API. – Riferimento APIaprirà la documentazione dell'API che spiega come richiamare gli endpoint dell'API RESTful per le azioni relative agli utenti e ai ruoli condivisi. – Modifica apre la configurazione della chiave API selezionata per consentirne la modifica. – Rimuovere Elimina la configurazione della chiave API selezionata.

Configurazione chiave API

Articolo	Descrizione
Nome	Nome della chiave API.
Descrizione	[Opzionale] Descrizione della chiave API.
Dettagli di sicurezza
Digitare	Selezionare ‘Tutti gli utenti del dominio’ per consentire a chiunque di eseguire una chiamata API, oppure ‘Utenti specifici’ per consentire solo a persone specifiche l’accesso alla chiave API.
Indirizzo e-mail dell'utente	Cerca l'indirizzo email degli utenti all'interno del dominio per concedere loro l'accesso a questa chiave API. (Nascosto se è selezionato ‘Tutti gli utenti del dominio’ per Tipo.)
Dettagli accesso
Entità	Selezionare ‘Utenti’ o ‘Ruoli condivisi’. (Quando viene creata una nuova chiave API, entrambe le voci sono già elencate nella sezione “Dettagli di accesso”.)
Ambiti di selezione	Imposta l'ambito o le autorizzazioni consentite per i record del modulo selezionato. Le opzioni disponibili per gli "Utenti" sono: – Crea Utente – Sospendi utente – Attiva Utente – Visualizza e cerca utenti – Esporta i record in formato PDF – Visualizza Modulo Opzioni per ‘Ruoli Condivisi’ sono: – Crea Ruolo Condiviso – Aggiorna ruolo condiviso – Elimina ruolo condiviso – Visualizza e cerca i ruoli condivisi – Aggiungi Utente a Ruolo Condiviso – Rimuovere l'utente dal ruolo condiviso (Quando viene creata una nuova chiave API, ogni entità avrà tutti gli Scopes abilitati. Puoi deselezionare gli Scopes per disabilitare il permesso.)

Best Practice per la configurazione delle API Key

Le chiavi API sono una semplice stringa crittografata che può essere utilizzata per generare un token bearer, che a sua volta verrà utilizzato per chiamare le API delle tue GW Apps. Assicurati di mantenere sicure tutte le tue chiavi API. L'esposizione pubblica delle tue credenziali può portare al compromesso dei tuoi dati.

Mentre generi le tue chiavi API, tieni a mente i seguenti suggerimenti:

• Restringi le tue chiavi API permettere solo indirizzi email specificiConsigliamo di creare le chiavi API utilizzando il tipo ‘Seleziona utenti’ e poi selezionando solo gli indirizzi email degli utenti che desideri accedere ai record tramite API. L'API recupererà i dati in base agli utenti selezionati con cui è stato generato il token, quindi l'API avrà accesso solo agli stessi dati in questa app a cui gli utenti selezionati hanno accesso. Puoi anche selezionare ‘Tutti gli utenti del dominio’, che ti permetterà di agire come qualsiasi utente in GW Apps e, quindi, avere pieno accesso a tutti i dati per i moduli elencati.
• Limita le tue chiavi API all'utilizzo solo per determinati moduli e ambitiSeleziona i moduli e gli ambiti a cui la tua chiave API ha accesso. In questo modo verrà limitato il livello di accesso di questa chiave API. Nota: uno ambito definisce solo quali azioni è consentito eseguire a una chiamata API, non concede l'accesso ad alcun dato per gli utenti selezionati, o a tutti gli utenti se è stato selezionato ‘Tutti gli utenti del dominio’ per il Tipo. La normale sicurezza di accesso dell'utente si applica a tutte le chiamate API. Ciò significa che se è abilitato l'ambito ‘Creazione record’, se l'utente che effettua la chiamata API non dispone dei diritti per creare record (‘Chi può creare nuovi record’ nella scheda Impostazioni del modulo), l'API restituirà un errore 401 non autorizzato.
• Rigenera periodicamente le tue chiavi APIPuoi rigenerare le chiavi API dalla pagina Elenco chiavi API facendo clic su `Genera nuova chiave` per ciascuna chiave. Quindi, aggiorna le tue applicazioni per utilizzare le chiavi appena generate. In questo modo, anche se una chiave API viene trovata da utenti indesiderati, diventerà non valida dopo un certo periodo poiché è stata generata una nuova chiave.
• Abilita / Disabilita chiavi APIPuoi disabilitare la tua chiave API in qualsiasi momento, ciò disabiliterà qualsiasi chiamata che tenterà di utilizzare tale chiave API.
• Elimina le chiavi API non necessariePer ridurre al minimo la tua esposizione agli attacchi, elimina qualsiasi chiave API di cui non hai più bisogno.

Impostazioni API aggiuntive

Questo articolo tratta le opzioni delle API a livello di piattaforma. Ulteriori opzioni per le chiavi API si trovano nella documentazione delle opzioni delle API in-app. Scopri di più su come aggiungere chiavi alle tue applicazioni. qui.