Vai al contenuto principale
In Vantage puoi creare, configurare ed eliminare i client Public API.

Creazione del primo client Public API in un tenant

Per creare un client Public API, segui questi passaggi:
  1. In Vantage, fai clic su Configuration.
  2. Nella finestra di dialogo Tenant Adminstration, fai clic su Create API Client.
Create API Client Nella finestra di dialogo Client Created verranno visualizzati il Client ID e il Client Secret. Client ID and Secret Dialog
  1. Per copiare ciascun valore, fai clic sull’icona copia accanto a ciascuno di essi. In alternativa, fai clic su Save to File per scaricare un file TXT contenente entrambi i valori.
Importante! Il valore del secret viene mostrato una sola volta durante la creazione del client, pertanto deve essere salvato immediatamente.
  1. Fai clic su Close.
    Viene visualizzata la pagina Public API Client.

Creazione di client API pubblici aggiuntivi

Per creare client API pubblici aggiuntivi, segui questi passaggi:
  1. In Vantage, fai clic su Configuration.
  2. Nella finestra di dialogo Tenant Adminstration, fai clic su Public API Client.
  3. Nella pagina Public API Client, fai clic sull’elenco a discesa New Client e quindi su Add Client.
Elenco a discesa New Client Nella finestra di dialogo Client Created vengono visualizzati il Client ID e il Client Secret.
  1. Per copiare ciascun valore, fai clic sull’icona di copia accanto a ciascuno di essi. In alternativa, fai clic su Save to File per scaricare un file TXT contenente entrambi i valori.
Importante! Il valore del Client Secret viene mostrato una sola volta durante la creazione del client, pertanto deve essere salvato immediatamente.
  1. Fai clic su Close.
    Viene visualizzata la pagina Public API Client.

Configurare un client API pubblico

Dopo aver creato un client API pubblico, è necessario configurarlo. Per modificare le impostazioni del client API pubblico, fare clic sul nome del client oppure cercare per nome del client o per ruoli del principal dell’applicazione. Per configurare un client API pubblico, seguire questi passaggi:
  1. Nel field Client Name, immettere il nome del nuovo client API pubblico.
Configurazione OAuth 2.0
  1. Per creare un nuovo secret, fare clic su Add Secret. Per impostazione predefinita, un secret viene creato per un periodo di 6 mesi. È possibile modificare il tempo di scadenza e impostarlo fino a 36 mesi.
  2. Per aggiungere una nuova redirect URL, fare clic su Add Redirect URL.
  3. Configurare i flussi di autenticazione consentiti nella sezione OAuth 2.0 Flows Settings.
    Nota: Questo flusso non funziona quando è configurato un External Identity Provider.
    È possibile selezionare più di un flusso:
    • Allow Authorization Code Flow. Consente l’autenticazione utilizzando questo schema di autenticazione sicuro, in cui, invece di indirizzare la richiesta di autenticazione all’utente, l’applicazione la invia direttamente al server di autorizzazione di Vantage. Il server di autorizzazione verifica quindi le credenziali dell’utente e fornisce al client un authorization code. Authorization Code Flow è abilitato per tutti i client Vantage API. Se necessario:
      • Selezionare l’opzione Require PKCE for Authorization Code Flow. Questa opzione rafforza la sicurezza durante l’autorizzazione dei client pubblici. Consente a Vantage di verificare che l’applicazione che richiede un access token sia la stessa che ha avviato l’autenticazione.
    • Allow Resource Owner Password Credentials Flow. Consente agli utenti di autenticarsi utilizzando il proprio username e password. Questo comporta che l’applicazione abbia accesso alla password dell’utente e richiede un elevato livello di fiducia tra l’utente e l’applicazione.
    • Selezionare Allow issuing refresh tokens to refresh access tokens. Questa opzione consente l’emissione di refresh token per ottenere access token rinnovati. L’applicazione può richiedere nuovi access token utilizzando i refresh token senza interagire con l’utente. Le applicazioni devono memorizzare i refresh token in modo sicuro perché consentono all’utente di rimanere autenticato.
  4. Allow client credentials flow. Consente alle applicazioni di essere autorizzate utilizzando il flusso OAuth 2.0 Client Credentials, concedendo loro l’accesso alla Vantage API. I ruoli assegnati alle applicazioni sono determinati dall’impostazione Manage Roles sotto Allow client credentials flow. Con i ruoli specificati, l’applicazione effettuerà l’accesso a Vantage.
  5. Configurare le Token Lifetime Settings:
    • Access Token. Definisce il periodo di tempo durante il quale l’access token emesso consente l’accesso dell’utente a Vantage. La durata predefinita di un access token è di 24 ore.
    • Refresh Token. Definisce il periodo di tempo assoluto a partire dall’emissione del primo access token durante il quale il refresh token emesso può essere utilizzato per rinnovare l’access token. La durata predefinita di un refresh token è di 30 giorni.
Per ulteriori informazioni sui flussi di autenticazione, vedere Authentication.

Eliminare un client API pubblico

Per eliminare un client, fai clic sull’icona e quindi fai clic su Delete Client. Elimina client