Dati dell'applicazione OAuth
Una volta creata un'app OAuth, Webgate.io ti fornisce i seguenti dati per la tua applicazione OAuth:
Il Client Id è un identificatore univoco per un'applicazione OAuth che le permette di essere riconosciuta dal server di autorizzazione.
Il Client Secret è una chiave riservata usata da un'applicazione OAuth per autenticarsi presso il server di autorizzazione, garantendo una comunicazione sicura.
Ogni URI di redirect ha un URL di autorizzazione univoco che punta a un endpoint verso cui gli utenti vengono reindirizzati per concedere l'accesso a un'applicazione. Questi URL gestiscono l'autenticazione e l'autorizzazione degli utenti, consentendo all'app di ricevere un codice di autorizzazione.
Per far autorizzare dall'utente la tua applicazione web ad accedere a Webgate.io, collega l'URL di autorizzazione. Quando l'utente segue questo link, deve autorizzare la tua applicazione ad accedere a Webgate.io. Poi viene reindirizzato alla tua applicazione usando il redirect url. Questo redirect passa un grant di accesso alla tua applicazione.
Questo grant di accesso ha vita breve e deve essere scambiato con un token di accesso usando il token endpoint, che puoi usare per effettuare richieste API autorizzate.
Includi il token di accesso negli header (di solito come Bearer token) delle chiamate API successive per accedere alle risorse protette per conto dell'utente.
Il token di accesso ha comunque una durata limitata. Per l'accesso a lungo termine è necessario ottenere un refresh token (sempre tramite il token endpoint), che può essere usato per richiedere un nuovo token di accesso quando quello attuale scade.
Scorciatoia per l'uso in sviluppo, documentazione API e script
Sebbene OAuth offra un metodo definito per integrare applicazioni web, seguire l'intero processo può essere scomodo quando vuoi solo provare alcune chiamate API, usare la documentazione interattiva o usare l'API da uno script.
Per questo Webgate.io offre la possibilità di generare un grant di accesso e token di accesso e refresh usando il pulsante di generazione sotto gli URL di autorizzazione.
Il token di accesso può essere usato come bearer di autorizzazione nella documentazione Swagger o nelle richieste di test.
Il refresh token è adatto all'uso negli script. Prima di effettuare altre chiamate API, il refresh token deve essere usato per creare un token di accesso tramite il /oauth/token endpoint. Invia client id e client secret come autenticazione HTTP Basic nell'header Authorization, e il grant type "refresh_token" insieme al refresh token nel corpo della richiesta. Mai nell'URL — le query string finiscono nei log del server.
Tieni presente che refresh token e client secret devono essere mantenuti segreti per evitare accessi non autorizzati.