Le chiavi API sono semplici stringhe crittografate che possono essere utilizzate per generare un token portatore, che a sua volta verrà utilizzato per richiamare le API GW Apps relative al tuo dominio. Assicurati di conservare tutte le tue chiavi in modo sicuro. L'esposizione pubblica delle tue credenziali può compromettere i 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 quella chiave saranno ignorate da GW Apps. |
 | Seleziona i tre puntini per visualizzare le opzioni relative al tasto selezionato. |
 | – Generare una nuova chiave genererà una nuova chiave API. Ciò invaliderà la chiave precedente, quindi sarà necessario condividere la nuova chiave con gli sviluppatori dei servizi che accedono a questa API. – Riferimento APIaprirà la documentazione API su come richiamare gli endpoint API RESTful per le azioni utente e ruolo condiviso. – Modifica apre la configurazione della chiave API selezionata per la modifica. – Rimuovi Elimina la configurazione della chiave API selezionata. |
Configurazione chiave API
| Articolo | Descrizione |
| Nome | Nome della chiave API. |
| Descrizione | [Facoltativo] Descrizione della chiave API. |
| Dettagli sulla sicurezza | |
| Tipo | Seleziona "Tutti gli utenti del dominio" per consentire a chiunque di eseguire una chiamata API, oppure "Utenti specifici" per consentire solo a determinate persone di accedere alla chiave API. |
| Email utente | Cerca l'indirizzo e-mail degli utenti all'interno del dominio per concedere loro l'accesso all'utilizzo di questa chiave API. (Nascosto se per Tipo è selezionato "Tutti gli utenti del dominio"). |
| Dettagli di accesso | |
| Entità | Selezionare "Utenti" o "Ruoli condivisi". (Quando viene creata una nuova chiave API, entrambe le entità sono già elencate in Dettagli accesso). |
| Ambito di selezione | Imposta l'ambito o le autorizzazioni consentite per i record del modulo selezionato. Le opzioni per "Utenti" sono: – Crea utente – Sospendi utente – Attiva utente – Visualizza e cerca utenti – Esporta record in PDF – Visualizza modulo Le opzioni per "Ruoli condivisi" sono: – Creare un ruolo condiviso – Aggiornare un ruolo condiviso – Eliminare un ruolo condiviso – Visualizzare e cercare ruoli condivisi – Aggiungere un utente a un ruolo condiviso – Rimuovere un utente da un ruolo condiviso (Quando viene creata una nuova chiave API, ogni entità avrà tutti gli ambiti abilitati. È possibile deselezionare gli ambiti per disabilitare l'autorizzazione). |
Best practice per la configurazione delle chiavi API
Le chiavi API sono semplici stringhe crittografate che possono essere utilizzate per generare un token bearer, che a sua volta verrà utilizzato per richiamare le API delle tue app GW. Assicurati di conservare tutte le tue chiavi API in modo sicuro. L'esposizione pubblica delle tue credenziali può compromettere la sicurezza dei tuoi dati.
Durante la generazione delle chiavi API, tieni presente i seguenti suggerimenti:
- Limita le tue chiavi API per consentire solo indirizzi e-mail specifici: ti consigliamo di creare chiavi API utilizzando il tipo "Seleziona utenti" e quindi selezionando solo gli indirizzi e-mail degli utenti che desideri abbiano accesso ai record tramite l'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 hanno accesso gli utenti selezionati. Puoi anche selezionare "Tutti gli utenti del dominio", che ti consentirà di agire come qualsiasi utente in GW Apps e quindi di avere pieno accesso a tutti i dati dei moduli elencati.
- Limita l'utilizzo delle tue chiavi API solo a determinati moduli e ambiti: seleziona a quali moduli e ambiti la tua chiave API ha accesso. In questo modo limiterai il livello di accesso di questa chiave API. Nota: un ambito definisce solo quali azioni è consentito eseguire a una chiamata API, non concede l'accesso a nessun dato per gli utenti selezionati o per tutti gli utenti se per il Tipo è selezionato "Tutti gli utenti del dominio". La normale sicurezza di accesso degli utenti si applica a tutte le chiamate API. Ciò significa che se l'ambito "Creazione record" è abilitato, se l'utente che chiama l'API non ha i 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 API: puoi 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 perché è stata generata una nuova chiave.
- Abilita/Disabilita chiavi API: puoi disabilitare la tua chiave API in qualsiasi momento, ciò disabiliterà qualsiasi chiamata che tenti di utilizzare quella chiave API.
- Elimina le chiavi API non necessarie: per ridurre al minimo l'esposizione agli attacchi, elimina tutte le chiavi API che non ti servono più.
Impostazioni API aggiuntive
Questo articolo tratta le opzioni API a livello di piattaforma. Ulteriori opzioni per le chiavi API sono disponibili nella documentazione relativa alle opzioni API in-app. Per ulteriori informazioni sull'aggiunta di chiavi alle applicazioni, clicca qui.