Workiva-ondersteuningscentrum

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 deWorkiva Platform Code Generationpagina.
2. Download het OpenAPIoas.yamlbestand.

3. OpenBruno. Klik in de linkerbovenhoek op het + pictogram en selecteerCollectie importeren.

   

4. Klik op de link "bestand(en) kiezen" en selecteer het gedownloade.yamlbestand.

   

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

   U kunt desgewenst de mapindeling wijzigen van 'Tags' naar 'Paden' en op 'Importeren' klikken.

   

Stap 2: De globale omgeving configureren

1. Klik in het gedeelte Werkruimte van Bruno op het tabbladGlobale omgevingen en vervolgens opOmgeving maken.

   

2. Typ een naam voor uw globale omgeving en klik vervolgens opAanmaken.

    

3. Maak de volgende globale variabelen aan:
   • toegang_token
   • ClientID
   • ClientSecret
   • api_versie

4. Vul de waarden in voorClientIDenClientSecret. Laataccess_tokenleeg en stelapi_versionin op2026-01-01.

   

5. Sla de variabelen op.

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 deWorkiva APIcollectie in het werkruimtegedeelte van Bruno.

   

2. Klik op het Workiva-dropdownmenu in de rechterbovenhoek van het Bruno-scherm en selecteer de juiste omgeving/regio uit de lijst met collecties.

   

3. Klik op het tabblad "Auth", selecteer "Bearer Token" in het vervolgkeuzemenu en stel het veld "Token" in op de variabele{{access_token}}.

   

4. Selecteer het tabbladScript.

5. Voeg het volgende script toe aan dePre-requestsectie.

   Voor2026 Platform API'sis deX-Versionheader 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. Documentatie is hier te vinden: https://developers.workiva.com/2026-01-01/versioning.html

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

   

   Klik op de knop 'Opslaan' linksonder in het werkgebied wanneer u klaar bent.

6. Ga in de Workiva API-collectie naar de mapoauth2 > tokenen klik opEen token ophalen om deze te openen.

   

7. Klik op het ">>"-pictogram onder de URL en klik vervolgens op het tabblad "Script".

   

   Voeg in het scriptgedeeltePost Responsehet volgende toe om het token globaal op te slaan:

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

8. Sla je wijzigingen op.

Stap 3a (optioneel): Importeer extra Workiva API's

Volg dezelfde stappen als hierboven om extra Workiva API's te importeren:

wData OpenAPIoas.yamlbestand kan hier gedownload worden

Ketens OpenAPIoas.yamlbestand kan hier gedownload worden

Stap 4: Genereer een Bearer Token

1. Stel voor de OAuth2-aanvraagbody de volgende variabelen in (indien deze nog niet zijn ingesteld):
   • {{ClientID}}
   • {{ClientSecret}}

     • Om de variabelen in te stellen (of te controleren), klikt u op Workiva rechtsboven in de Bruno-werkruimte, vervolgens op het tabblad Globaal en kiest u 'Configureren'.

       

       Bewerk de variabelen indien nodig.

       

2. Verzend hetVerzoek 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.

Probleemoplossing

• Zorg ervoor dat je naar de juisteOmgevingverwijst. Als de collectie standaard de omgeving 'Geen' gebruikt, wijzig deze dan naaruw opgegeven omgeving.
• 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.