Workiva-ondersteuningscentrum

Deze handleiding leidt u door het proces van het importeren van Workiva API-collecties in Bruno met behulp van OpenAPI-specificaties. Je leert hoe je globale omgevingsvariabelen configureert, authenticeert met OAuth 2.0 en API-verzoeken van begin tot eind valideert.

Voorwaarden

1. Download en installeer Bruno via www.usebruno.com .

Achtergrond

De Workiva API's worden gepubliceerd in OpenAPI-formaat (.yaml). Deze specificaties kunnen direct worden geïmporteerd in API-clients zoals Bruno, waardoor u met volledig gestructureerde collecties kunt werken zonder handmatig verzoeken te hoeven samenstellen.

Stap 1: Importeer de Workiva API-collectie

1. Ga naar de pagina voor het genereren van Workiva-platformcode .
2. Download het OpenAPI .yaml bestand.

3. Open Bruno. Klik in de linkerbovenhoek op het menu met de drie puntjes en selecteer Collectie importeren.

   

4. Selecteer OpenAPI V3-bestand en kies het gedownloade .yaml-bestand.

   

5. Maak, wanneer daarom wordt gevraagd, een lokale map aan of selecteer er een waar Bruno de verzameling zal opslaan (bijvoorbeeld Bruno Collecties).

   

Stap 2: De globale omgeving configureren

1. Klik in de rechterbovenhoek van Bruno op het wereldbolpictogram en selecteer Configureren.

   

2. Kies Maak een globale omgeving.
3. Maak de volgende globale variabelen aan:
   • toegang_token
   • Omgeving
   • ClientID
   • ClientSecret
   • api_versie

4. Vul de waarden in voor Omgeving, ClientID, en ClientSecret. Laat access_token leeg en stel api_version in op 2026-01-01.

   

5. Bescherm het milieu.

Stap 3: OAuth 2.0 configureren – Een token ophalen

Om authenticatie te hergebruiken in meerdere collecties, wordt het OAuth-toegangstoken opgeslagen als een globale omgevingsvariabele .

1. Selecteer de Workiva API collectie.
2. Selecteer het tabblad Variabelen.

3. Werk de variabele baseUrl bij zodat deze {{environment}} gebruikt in plaats van een vastgelegd domein.

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

   Bijgewerkt:
   https://api.{{environment}}.wdesk.com

4. Stel de autorisatie in op Bearer Token en gebruik de {{access_token}} variabele.
5. Selecteer het tabblad Scripts.

6. Voeg het volgende script toe aan de Pre-request sectie.

   Voor 2026 Platform API'sis de X-Version header vereist bij elk verzoek. Dit script zorgt ervoor dat de header consistent wordt toegepast in de hele collectie, in overeenstemming met de API-versievereisten van Workiva voor 2026.

   Opmerking: Deze vereiste is momenteel alleen van toepassing op Platform API's.

   // Voeg de X-versieheader toe of werk deze bij (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

7. Ga in de Workiva API-collectie naar de map oauth2 en open Een token ophalen.

8. Voeg in het scriptgedeelte Post Response het volgende toe om het token globaal op te slaan:

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

9. Sla je wijzigingen op.

Stap 4: Genereer een Bearer Token

1. Stel in de body van het OAuth2-verzoek het volgende in:
   • {{ClientID}}
   • {{ClientSecret}}
2. Verzend het Verzoek om een ​​token op te halen

3. Indien succesvol, zal het antwoord een Bearer-token bevatten en deze wordt automatisch opgeslagen als een globale variabele .

   

Je kunt nu geauthenticeerde verzoeken verzenden. Als het gelukt is, zie je je documentenlijst terug in het antwoord.

Stap 5: Importeer en configureer de Wdata- en Chains-API-verzameling

1. Ga naar de Wdata Code Generation pagina.
2. Download het .yaml bestand en importeer het in Postman (Volg de stappen beschreven in Stap 1: De Workiva API-collectie importeren). Opmerking: De .yaml bestandsnaam zal waarschijnlijk hetzelfde zijn als de Workiva API Collection.
3. In de Wdata collectie:
   • Selecteer het tabblad Variabelen.

   • Werk de variabele baseUrl bij zodat deze {{environment}} gebruikt in plaats van een vastgelegd domein.

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

     Bijgewerkt:
     https://h.{{environment}}.wdesk.com/s/wdata/prep

   • Stel de autorisatie in op Bearer Token en gebruik de {{access_token}} variabele.
   • Herhaal de bovenstaande stappen voor de Chains API Collectionen zorg ervoor dat de autorisatie-instellingen en de baseUrl variabele op dezelfde manier geconfigureerd zijn.

Probleemoplossing

• Zorg ervoor dat je naar de juiste Omgevingverwijst. Als de collectie standaard de omgeving 'Geen' gebruikt, wijzig deze dan naar uw opgegeven omgeving.
• Controleer of de variabele baseUrl consistent is in uw omgeving en collectie-instellingen.
• Zorg ervoor dat je de collectievariabele baseUrl instelt op {{environment}}; anders kunnen je verzoeken mislukken.
• Als uw verzoek een 401-fout of een lege reactie oplevert, controleer dan of uw Client ID, Client Secret, API_version en Environment-waarden correct zijn.