Creazione, configurazione ed eliminazione di un client API pubblico

Crea, configura ed elimina i client API pubblici nell’interfaccia utente di ABBYY Vantage — gestisci segreti client, URI di reindirizzamento, flussi OAuth 2.0 e durata di validità dei token.

Usa l’interfaccia utente di Vantage per creare, configurare ed eliminare i client API pubblici che le applicazioni integrate usano per autenticarsi alla Vantage API. Per l’alternativa a livello di programmazione, vedi Creare un client usando la Vantage API.

Solo un Tenant Administrator può creare o gestire i client API pubblici.

​

Creazione di un client API pubblico

1. Apri Configurazione

   In Vantage, fai clic su Configurazione nel riquadro sinistro.

2. Avvia la creazione del client

   Nella finestra di dialogo Amministrazione tenant, esegui una delle seguenti operazioni:

   • Primo client in questo tenant: fai clic su Crea client API.
   • Client successivi: fai clic su Client API pubblico, quindi nella pagina Client API pubblico apri l’elenco a discesa Nuovo client e fai clic su Aggiungi client.

   
3. Copia il Client ID e il Client Secret

   Nella finestra di dialogo Client creato, copia ciascun valore facendo clic sulla relativa icona copy. In alternativa, fai clic su Salva su file per scaricare un file TXT che contiene entrambi i valori.

   

   Il Client Secret viene visualizzato una sola volta, al momento della creazione. Salvalo immediatamente: non potrai più visualizzarne l’intero valore.

4. Chiudi la finestra di dialogo

   Fai clic su Chiudi. Si apre la pagina Client API pubblico, in cui puoi configurare il nuovo client.

​

Configurare un client API pubblico

Dopo aver creato un client API pubblico, configurane le impostazioni.

Per aprire le impostazioni di un client, fai clic sul nome del client nella pagina Public API Client oppure cerca per nome del client o per ruoli del principal dell’applicazione.

1. Assegna un nome al client

   Nel field Client Name, inserisci un nome che identifichi il client.

2. Gestisci i secret

   Fai clic su Add Secret per creare un nuovo segreto client. Per impostazione predefinita, il nuovo secret scade dopo 6 mesi, ma puoi impostare una scadenza da 1 giorno fino a 36 mesi.

3. Aggiungi URL di reindirizzamento

   Fai clic su Add Redirect URL e inserisci ogni URL verso cui vuoi consentire il reindirizzamento dell’autorizzazione.

4. Configura i flussi OAuth 2.0

   Nella sezione OAuth 2.0 Flows Settings, seleziona uno o più flussi che il client può utilizzare:

   • Allow Authorization Code Flow — uno schema di autenticazione sicuro in cui l’applicazione invia la richiesta di autenticazione direttamente al server di autorizzazione di Vantage. Il server verifica le credenziali e restituisce un codice di autorizzazione. Questo flusso è abilitato per tutti i client Vantage API.
     • Require PKCE for Authorization Code Flow — rafforza la sicurezza dei client pubblici consentendo a Vantage di verificare che l’applicazione che richiede il token di accesso sia la stessa che ha avviato l’autenticazione.
   • Allow Resource Owner Password Credentials Flow — consente agli utenti di autenticarsi con nome utente e password. L’applicazione ha accesso diretto alla password dell’utente, quindi usa questa opzione solo con applicazioni di cui l’utente si fida completamente.
   • Allow issuing refresh tokens to refresh access tokens — consente al client di emettere refresh token per rinnovare i token di accesso senza richiedere nuovamente l’intervento dell’utente. Le applicazioni devono archiviare i refresh token in modo sicuro.
   • Allow client credentials flow — concede alle applicazioni l’accesso alla Vantage API tramite il flusso OAuth 2.0 Client Credentials. I ruoli sono determinati dall’impostazione Manage Roles sotto questa opzione.

   Il flusso Resource Owner Password Credentials non funziona quando è configurato un provider di identità esterno. Vedi Authentication.

5. Imposta la durata dei token

   Nella sezione Token Lifetime Settings, configura:

   • Access Token — il periodo durante il quale un token di accesso emesso consente l’accesso a Vantage. Predefinito: 24 ore.
   • Refresh Token — il periodo assoluto che inizia con l’emissione del primo token di accesso, durante il quale il refresh token può rinnovare il token di accesso. Predefinito: 30 giorni.

Per ulteriori informazioni sui flussi di autenticazione, vedi Authentication.

​

Eliminazione di un client API pubblico

Per eliminare un client, fai clic sulla sua icona nella pagina client API pubblico e quindi su Delete Client.