|
A partire da gennaio 2021, i tipi di file classici non potranno più essere utilizzati. È possibile effettuare la transizione dei file classici o scaricare un PDF. Ulteriori informazioni

Centro assistenza di Workiva

CLP - Richiesta HTTP Genera Token di Accesso

CLP - Richiesta HTTP Genera Token di Accesso

  • Ultimo aggiornamento
Correlato a chains Http

Vuoi connetterti a un'applicazione di terze parti al di là dei connettori Premium precostituiti di Workiva? Puoi farlo sfruttando i comandi HTTP Request Connector Commands per interagire con le API REST. 

In questo Percorso Didattico Collegato, creeremo una Catena che si autentica con un'API di terze parti per ottenere un token al portatore.  Anche se la dimostrazione avverrà utilizzando l'API di Workiva, i principi e il processo possono essere applicati per connettersi a diverse altre API.

Caso d'uso primario dell'azienda Connessione a sistemi di terze parti
Obiettivo di apprendimento primario Imparare i concetti fondamentali di Chains e sfruttare i comandi HTTP Request Connector di Workiva per connettersi e autenticarsi alle API REST di terze parti.
Obiettivo di apprendimento secondario Creare le variabili dello spazio di lavoro
Prerequisiti Configurazione di Workiva API Grant
Configurazione del connettore di richiesta HTTP
Modello di supporto CLP | Genera token di accesso

 

Passo 1: Creare le variabili dell'area di lavoro

Per utilizzare i dettagli dell'API di Workiva in più catene e comandi, creeremo delle variabili di Workspace per memorizzare queste informazioni. Creeremo tre variabili dello spazio di lavoro per i seguenti dati: API Grant Client ID e Client Secret e IAM (identity and access management) Base URL.

  1. Da Chain Builder, vai a Workspace Settings.
  2. In Variabili dell'area di lavoro, clicca sul segno più (+) tre volte per creare tre variabili dell'area di lavoro e configurarle come segue:
    • Variabile 1:
    • Variabile 2:
      • Nome: wsv-Workiva API Client Secret
      • Valore: Inserisci l'ID cliente della tua sovvenzione API.
        Per trovare il Segreto del Cliente, accedi al tuo Profilo all'interno della Piattaforma Workiva e individua la Sovvenzione API nella scheda Sicurezza.
        Segui le seguenti istruzioni per trovare il Segreto del Cliente

      • Clicca sul pulsante di blocco per criptare il tuo Segreto cliente.

        È importante mantenere i Segreti del Cliente al sicuro; salva il Segreto del Cliente in un luogo sicuro nel caso in cui tu abbia bisogno di accedervi di nuovo.

    • Variabile 3:

      • Nome: wsv-BaseURL-IAM
      • Valore: Inserisci il valore sottostante in base alla tua regione. Puoi verificare la regione controllando l'URL. Se l'URL contiene EU o APAC, utilizza l'URL corrispondente.
      Nota: La regione USA contiene solo "app".
      Campo Valore USA
      URL base IAM https://api.app.wdesk.com
      Campo Valore UE
      URL base IAM https://api.eu.wdesk.com
      Campo Valore APAC
      URL base IAM https://api.apac.wdesk.com
    • Salva le impostazioni dell'area di lavoro.

Passo 2: Creare una catena

Per generare il token del portatore, creeremo una nuova catena con un comando POST; questo ci fornirà il token del portatore di cui abbiamo bisogno.

  1. Vai alla scheda Chains del Chain Builder.
  2. Crea una nuova Catena e assegnale un nome: CLP | Generate Access Token.
  3. Includi un Descrizione: Questa catena genera un nuovo Token di accesso API di Workiva.  Devi fornire un ID cliente e un Segreto cliente validi provenienti da una concessione API generata in precedenza nei valori delle variabili sottostanti.
  4. Salva la catena.

Passo 3: Recuperare un token

Questa catena utilizza un comando POST dal connettore di richiesta HTTP per recuperare il nostro token del portatore. Il Bearer Token è una credenziale di autenticazione fondamentale per accedere alle API. Una volta ottenuto all'interno della Catena, il token può essere utilizzato nei comandi successivi per fornire l'autorizzazione a interagire con l'API.

  1. Aggiungi un comando Post dal connettore HTTP Request all'area iniziale.
  2. Fai doppio clic sul comando per configurarlo.
    • Rinomina il comando: POST - Recupera un token.
    • Seleziona la casella di controllo Show response.
    • Inserisci nel campo URL l'URL dell'endpoint da raggiungere. Per recuperare un token per l'API di Workiva, popola l'URL con il seguente testo, utilizzando la variabile Workspace per popolare l'URL di base IAM.
      1. Clicca su URL e poi su Workspace nel pannello "Seleziona una variabile" e seleziona la variabile creata nel passaggio 1 (wsv-BaseURL-IAM).
      2. Aggiungi /oauth2/token dopo la variabile.
    • Nel campo Content Type inserisci: application/x-www-form-urlencoded.
  • Usa il segno Plus per aggiungere un campo Header .
    • Chiave: Accept
    • Valore: application/json
  • Usare il segno più per aggiungere un altro campo Intestazione .
    • Chiave: Versione X
    • Valore: 2026-01-01

Indicheremo all'endpoint come eseguire l'operazione utilizzando i parametri inseriti nel modulo postale . Per farlo, clicca 4 volte sul pulsante verde più accanto alla sezione Modulo e popola ogni campo con i valori sottostanti, prestando particolare attenzione alle lettere maiuscole e minuscole.

  • Campo 1:
    • Nome: client_id
    • Valore: <wsv-Workiva>
      Nel pannello Seleziona una variabile, clicca sulla freccia verso il basso per espandere Area di lavoro e seleziona wsv-Workiva API Client ID.
  • Campo 2:
    • Nome: client_secret
    • Valore: <wsv-Workiva>
      Nel pannello Seleziona una variabile, clicca sulla freccia verso il basso per espandere Area di lavoro e seleziona wsv-Workiva API Client Secret.
  • Campo 3:
    • Nome: grant_type
    • Valore: client_credentials
  • Campo 4:
    • Nome: ambito
    • Valore: Aggiungi facoltativamente un valore per specificare a quali ambiti questo token deve avere accesso.

  • Popola la risposta con il payload di esempio qui sotto; in questo modo forniamo un formato all'output del comando, rendendo ogni variabile restituita più facile da usare.

    {"access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }
  1. (Opzionale) Inserisci una Descrizione: "Questo comando HTTP esegue una chiamata POST per generare un token di accesso necessario per l'autenticazione nei comandi HTTP successivi che utilizzano l'API IAM di Workiva. Questo comando sfrutta le variabili dello spazio di lavoro per memorizzare l'URL di base dell'API IAM di Workiva e l'API Grant Client ID e Client Secret. Ulteriori informazioni sono disponibili qui: https://developers.workiva.com/2026-01-01/tokenrequest.html".
  2. Salva il comando.
Suggerimento. Per sapere come compilare i campi del modulo e della risposta, consulta la documentazione dello sviluppatore dell'endpoint API a cui ti stai connettendo. Per l'API di Workiva, puoi trovare la documentazione sul token del portatore qui.

Passo 4: Prova l'esercizio

Ora che la Catena è completa, verifica il risultato.

  1. Pubblica la Catena.
  2. Clicca su Execute e poi su Run Chain.

  3. Una volta completata l'esecuzione della catena, dovresti vedere che il token di accesso è stato generato nella scheda Outputs - Response Body del comando Post.

 

Scopri il prossimo esercizio all'interno del percorso di apprendimento HTTP Request Connected per imparare come utilizzare il token del portatore all'interno di un successivo Command List Spreadsheets.

Vuoi connetterti a un'applicazione di terze parti al di là dei connettori Premium precostituiti di Workiva? Puoi farl...