| Parameter | Descrizione |
|---|---|
| client_id | L’identificatore dell’applicazione. Per informazioni su come creare un Vantage API Client (client_id e client_secret), vedi l’articolo Managing Tenant Vantage API Clients. |
| redirect_uri | L’URL della tua applicazione o del tuo sito web a cui reindirizzare il browser una volta concesse le autorizzazioni di accesso. |
| response_type=code | Specifica che viene utilizzato il tipo di risposta “authorization code”. |
| scope=openid permissions global.wildcard | Specifica l’ambito delle autorizzazioni. |
| state | Un valore arbitrario di tipo string che conterrà l’esito dell’autorizzazione nella risposta. |
| code_challenge | Valore firmato digitalmente del code_verifier (utilizzando il metodo code_challenge_method). |
| code_challenge_method | Il metodo di firma digitale per il code_verifier (S256). |
| productId=a8548c9b-cb90-4c66-8567-d7372bb9b963 | L’identificatore di Vantage. |
I valori per response_type, scope, productId devono essere esattamente quelli indicati sopra. Queste chiavi, ad eccezione di response_type, possono cambiare. Valuta di mantenerle nella configurazione.Sample Request Un parametro denominato redirect_uri, che contiene l’identificatore della tua risorsa, viene utilizzato in OAuth 2.0 per consentire a Vantage di inviare il codice di autorizzazione alla tua risorsa e quindi scambiarlo con il token di accesso, necessario per l’autenticazione in tutte le chiamate API successive. L’uso di questo metodo di autenticazione richiede di fornire il valore del parametro redirect_uri all’assistenza tecnica di ABBYY affinché gli amministratori possano inserirlo nella lista consentita (whitelist). Una volta verificato che le autorizzazioni di accesso richieste tramite il parametro scope siano state concesse, il browser viene reindirizzato a una pagina web dedicata predisposta dal server Vantage. Questa pagina contiene una finestra di dialogo per eseguire l’autorizzazione con il tuo account. Questa pagina deve essere aperta in un browser con la barra degli indirizzi visibile, che ti consenta di verificare l’URL della pagina e lo stato del certificato SSL della connessione. Se il tuo indirizzo email è associato a più account in tenant diversi, dopo aver specificato l’indirizzo email ti verrà chiesto di selezionare un tenant e inserire la password. Puoi anche passare direttamente l’identificatore del tuo tenant (il parametro tokenId) utilizzando una delle seguenti risorse: or Ti verrà richiesto di inserire la password dell’account del tuo tenant. Dopo aver inserito le credenziali, l’autorizzazione viene completata lato server, all’applicazione viene concesso l’accesso alla Vantage API e riceverai il codice di autorizzazione nella risposta alla tua richiesta. Tieni presente che, se un sito o un’applicazione utilizza questo tipo di autenticazione, gli utenti di Vantage concederanno, per loro conto, l’accesso alla Vantage API al sito o all’app che stai aggiungendo all’elenco delle URL di reindirizzamento consentite. Per fornire l’accesso al sito o all’app, agli utenti verrà richiesto di autenticarsi in Vantage utilizzando il proprio nome utente e la propria password. Una volta che un utente è autenticato, al sito o all’app verranno concesse le seguenti autorizzazioni:
- Gestire i cataloghi di dati nel tenant Vantage per conto dell’utente,
- Accedere alle skill nel tenant Vantage per conto dell’utente,
- Creare e accedere alle transaction di Vantage per conto dell’utente.
application/x-www-form-urlencoded.
Parametri del corpo della richiesta:
| Parameter | Descrizione |
|---|---|
| code_verifier | Il codice che hai generato. Necessario per confermare l’avvio della richiesta di autorizzazione. |
| client_id | L’identificatore dell’applicazione. |
| client_secret | Chiave sicura dell’applicazione. |
| code | Il tuo codice di autorizzazione ottenuto dal server. |
| redirect_uri | L’URL di reindirizzamento utilizzato nella fase di autorizzazione. |
| grant_type=authorization_code | Specifica che viene utilizzato il tipo di grant “authorization code”. |
| scope=openid permissions global.wildcard offline_access | Specifica l’ambito delle autorizzazioni. Per ottenere un refresh token, aggiungi offline_access allo scope. |
token con il valore ricevuto:
Ottenere il refresh token
Allow issuing refresh tokens to refresh access tokens è stata abilitata durante la configurazione del client Vantage API e la richiesta per ottenere l’access token conteneva il parametro scope=openid permissions global.wildcard offline_access, nella risposta si riceverà anche un refresh token aggiuntivo. Una volta che disponi di un refresh token, puoi aggiornare l’access token utilizzando una richiesta POST all’endpoint del token con i seguenti Parameter:
| Parameter | Descrizione |
|---|---|
| client_id | L’identificatore dell’applicazione. |
| client_secret | Una chiave sicura dell’applicazione. |
| refresh_token | Il tuo refresh token ottenuto dal server. |
| grant_type=refresh_token | Specifica che viene utilizzato il grant type refresh token. |
Periodo di validità dei token
- Validità del token di accesso: Definisce l’intervallo di tempo durante il quale il token di accesso emesso consente all’utente di accedere a Vantage. La validità predefinita di un token di accesso è di 24 ore.
- Validità del token di refresh: Definisce il periodo di tempo assoluto che decorre dall’emissione del primo token di accesso, durante il quale il token di refresh emesso può essere utilizzato per rinnovare il token di accesso. La validità predefinita di un token di refresh è di 30 giorni.