GW Apps dispone di un'API che consente ai sistemi esterni autorizzati di leggere e modificare i record utilizzando un servizio web RESTful. La definizione di una chiave API consente di comunicare a GW Apps quali moduli specifici all'interno dell'applicazione possono consentire l'accesso all'API e quali operazioni l'API è autorizzata a eseguire. In questo articolo vedremo come creare e generare chiavi API per le vostre applicazioni. Discuteremo anche le opzioni di configurazione delle chiavi API.
Panoramica delle chiavi API
Le chiavi API consentono la creazione di endpoint RESTful che renderanno accessibili e modificabili i record di un determinato modulo tramite un servizio web.
| Chiavi API |
 |
 |
| Articolo | Descrizione |
| + Crea chiave API | Crea una nuova chiave API. |
| Nome | Nome della chiave API. |
| Descrizione | Breve descrizione della chiave API. |
| Creato il | Data di creazione della chiave API. |
| Creato da | Utente che ha creato la chiave API. |
| Abilitato | Attiva/disattiva l'opzione per abilitare/disabilitare l'accesso utilizzando questa chiave API. |
| Clicca su una riga | Quando clicchi su una riga della chiave API nell'elenco, sotto la riga si aprirà un pannello con i dettagli di riepilogo sulla configurazione della chiave API. |
 | Clicca sul menu con i tre puntini per visualizzare ulteriori opzioni. |
| Genera nuova chiave | Genera una nuova chiave di sicurezza per la configurazione della 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 API | Collegamento alla documentazione su come richiamare gli endpoint dell'API RESTful per il modulo specificato |
| Modifica | Modifica la configurazione della chiave API selezionata. |
| Rimuovi | Elimina la configurazione della chiave API selezionata. |
Creazione di una chiave API
Crea una nuova chiave API cliccando sul pulsante "+ Crea chiave API" e compilando il modulo visualizzato nella finestra pop-up:
| Creazione di una chiave API |
 |
Dopo aver inserito il nome della nuova chiave API, aver aggiunto eventualmente una descrizione e aver cliccato su "Crea", vedrai l'Editor chiave API con la tua nuova chiave caricata, in modo da poter completare la sua configurazione:
| Crea chiavi API |
 |
| Articolo | Descrizione |
| Chiave API generata | Stringa che rappresenta la chiave API generata, visibile solo al momento della creazione della chiave. Si consiglia vivamente di annotarla in un luogo sicuro, poiché non sarà più visibile una volta salvata e chiusa la schermata. |
| 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 | |
| Modulo | Seleziona un modulo dall'applicazione corrente che sarà accessibile tramite questa chiave API. (Quando viene creata una nuova chiave API, tutti i moduli all'interno dell'applicazione verranno aggiunti all'elenco dei moduli in Dettagli accesso.) |
| Seleziona ambiti | Imposta l'ambito o le autorizzazioni consentite per i record del modulo selezionato. Le opzioni sono: – Crea record – Aggiorna record – Elimina record – Visualizza e cerca record – Esporta record in PDF – Visualizza modulo (Quando viene creata una nuova chiave API, ogni modulo avrà tutti gli ambiti abilitati. È possibile deselezionare gli ambiti per disabilitare l'autorizzazione). |
 | Aggiungi l'accesso per un modulo aggiuntivo da questa applicazione. |
| Annulla | Annulla modifiche |
| Salva | Salva chiavi API |
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 GW Apps relative alle tue applicazioni. Assicurati di conservare tutte le tue chiavi in modo sicuro. L'esposizione pubblica delle tue credenziali può compromettere i tuoi dati.
Configurazioni chiave API
Durante la generazione della chiave API, è possibile configurare le seguenti opzioni di sicurezza:
- 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 garantisce 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 riflette le opzioni API disponibili nell'app. Ulteriori opzioni per le chiavi API sono disponibili nella sezione API delle impostazioni della piattaforma.