Centro assistenza di Workiva

Questa guida illustra come importare le raccolte API di Workiva in Bruno utilizzando le specifiche OpenAPI. Imparerete a configurare le variabili d'ambiente globali, ad autenticarvi con OAuth 2.0 e a convalidare le richieste API end-to-end.

Prerequisiti

1. Scaricare e installare Bruno da www.usebruno.com .

Background

Le API di Workiva sono pubblicate in formato OpenAPI (.yaml). Queste specifiche possono essere importate direttamente nei client API come Bruno, consentendo di lavorare con collezioni completamente strutturate senza costruire manualmente le richieste.

Passo 1: Importare la raccolta API di Workiva

1. Accedere alla pagina Workiva Platform Code Generation .
2. Scaricare il file OpenAPI .yaml.

3. Aprire Bruno. Nell'angolo in alto a sinistra, fare clic sul menu con i tre puntini e selezionare Importa collezione.

   

4. Selezionare il file OpenAPI V3 e scegliere il file .yaml scaricato.

   

5. Quando viene richiesto, creare o selezionare una cartella locale in cui Bruno memorizzerà la raccolta (ad esempio, Bruno Collections).

   

Passo 2: Configurazione dell'ambiente globale

1. Nell'angolo in alto a destra di Bruno, fare clic sull'icona del globo e selezionare Configura.

   

2. Scegliete Create Global Environment.
3. Creare le seguenti variabili globali:
   • access_token
   • Ambiente
   • ClientID
   • ClientSecret
   • api_version

4. Popolare i valori di Environment, ClientID, e ClientSecret. Lasciare vuoto access_token e impostare api_version a 2026-01-01.

   

5. Salviamo l'ambiente.

Passo 3: Configurare OAuth 2.0 - Recuperare un token

Per riutilizzare l'autenticazione in più collezioni, il token di accesso OAuth sarà memorizzato come variabile d'ambiente globale .

1. Selezionare la raccolta Workiva API.
2. Seleziona la scheda Variables.

3. Aggiorna la variabile baseUrl per utilizzare {{environment}} invece di un dominio codificato.

   Originale:
   https://api.app.wdesk.com

   Aggiornato:
   https://api.{{ambiente}}.wdesk.com

4. Impostare l'autorizzazione su Bearer Token e usare la variabile {{access_token}}.
5. Selezionare la scheda Scripts.

6. Aggiungere il seguente script alla sezione Pre-request.

   Per 2026 Platform API, l'intestazione X-Version è richiesta su ogni richiesta. Questo script assicura che l'intestazione sia applicata in modo coerente in tutta la raccolta, in linea con i requisiti di versionamento dell'API 2026 di Workiva.

   Nota: Questo requisito si applica attualmente solo alle API di piattaforma.

   // Aggiungere o aggiornare l'intestazione X-Version (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

7. Nella raccolta API di Workiva, navigare nella cartella oauth2 e aprire Retrieve a token.

8. Nella sezione dello script Post Response, aggiungere quanto segue per salvare il token a livello globale:

   const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token); 

9. Salva le modifiche.

Passo 4: Generare un gettone portatore

1. Nel corpo della richiesta OAuth2, impostare:
   • {{ClientID}}
   • {{ClientSecret}}
2. Inviare la richiesta Recuperare un token.

3. In caso di successo, la risposta includerà un token Bearer che verrà salvato automaticamente come variabile globale .

   

È ora possibile inviare richieste autenticate. In caso di successo, la risposta restituirà l'elenco dei documenti.

Passo 5: Importare e configurare la raccolta API Wdata e Chains

1. Andate alla pagina Wdata Code Generation.
2. Scaricare il file .yaml e importarlo in Postman (Seguire la procedura descritta in Passo 1: Importare la raccolta API di Workiva). Nota: Il nome del file .yaml sarà probabilmente lo stesso della Workiva API Collection.
3. Nella raccolta Wdata :
   • Seleziona la scheda Variables.

   • Aggiorna la variabile baseUrl per utilizzare {{environment}} invece di un dominio codificato.

     Originale:
     https://h.app.wdesk.com/s/wdata/oc/api

     Aggiornato:
     https://h.{{ambiente}}.wdesk.com/s/wdata/prep

   • Impostare l'autorizzazione su Bearer Token e usare la variabile {{access_token}}.
   • Ripetere gli stessi passi sopra descritti per la Chains API Collection, assicurandosi che le impostazioni di autorizzazione e la variabile baseUrl siano configurate allo stesso modo.

Risoluzione dei problemi

• Assicurati di fare riferimento all'ambiente corretto. Se la collezione ha come impostazione predefinita l'ambiente No, passa a l'ambiente specificato.
• Verifica che la variabile baseUrl sia coerente con le impostazioni dell'ambiente e della collezione.
• Assicurati di impostare la variabile di raccolta baseUrl per utilizzare {{environment}}; in caso contrario, le tue richieste potrebbero fallire.
• Se la richiesta restituisce una risposta 401 o vuota, ricontrollare che i valori di Client ID, Client Secret, API_version e Environment siano corretti.