Centro assistenza di Workiva

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 oas.yaml.

3. Aprire Bruno. Nell'angolo in alto a sinistra, fare clic sull'icona + e selezionare Import Collection.

   

4. Fare clic sul collegamento "choose file(s)" e scegliere il file .yaml scaricato.

   

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

   Opzionalmente, cambiare la disposizione delle cartelle da "Tag" a "Percorsi" e fare clic su Importa.

   

Passo 2: Configurazione dell'ambiente globale

1. Nella sezione Workspace di Bruno, fare clic sulla scheda Global Environments e poi su Create Environment.

   

2. Digitare un nome per l'ambiente globale, quindi fare clic su Create.

    

3. Creare le seguenti variabili globali:
   • access_token
   • ClientID
   • ClientSecret
   • api_version

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

   

5. Salvare le variabili.

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 dall'area Workspace di Bruno.

   

2. Fare clic sul menu a tendina Workiva nell'angolo superiore destro della schermata Bruno e selezionare l'ambiente/regione appropriato dall'elenco Collection.

   

3. Fare clic sulla scheda "Auth", selezionare "Bearer Token" dall'elenco a discesa e impostare il campo "Token" in modo che utilizzi la variabile {{access_token}}.

   

4. Selezionate la scheda Script.

5. 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. La documentazione è disponibile qui: https://developers.workiva.com/2026-01-01/versioning.html

   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")); 

   

   Al termine, fare clic sul pulsante "Salva" in basso a sinistra dell'area di lavoro.

6. Nella raccolta API di Workiva, navigare nella cartella oauth2 > token e fare clic su Retrieve a token per aprirla.

   

7. Fare clic sull'icona ">>" sotto l'URL e fare clic sulla scheda "Script".

   

   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); 

8. Salva le modifiche.

Passo 3a (facoltativo): Importare altre API di Workiva

Seguire la stessa sequenza di passaggi sopra descritti per importare altre API di Workiva:

wData OpenAPI oas.yaml file può essere scaricato da qui

Catene OpenAPI oas.yaml file può essere scaricato da qui

Passo 4: Generare un gettone portatore

1. Per il corpo della richiesta OAuth2, impostare le seguenti variabili (se non sono già state impostate):
   • {{ClientID}}
   • {{ClientSecret}}

     • Per impostare (o controllare) le variabili, fare clic su Workiva in alto a destra nell'area di lavoro di Bruno, fare clic sulla scheda Globale e scegliere "Configura".

       

       Modificare le variabili, se necessario.

       

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 .

Risoluzione dei problemi

• Assicurarsi di fare riferimento all'ambiente corretto. Se l'insieme ha come impostazione predefinita l'ambiente No, passare a l'ambiente specificato.
• Se la richiesta restituisce una risposta 401 o vuota, ricontrollare che i valori di Client ID, Client Secret, API_version e Environment siano corretti.