Workiva kundestøttesenter

Denne veiledningen hjelper deg med å importere Workiva API-samlinger til Bruno ved hjelp av OpenAPI-spesifikasjoner. Du lærer hvordan du konfigurerer globale miljøvariabler, autentiserer ved hjelp av OAuth 2.0 og validerer API-forespørsler fra ende til ende.

Forutsetninger

1. Last ned og installer Bruno fra www.usebruno.com .

Bakgrunn

Workiva API-er publiseres i OpenAPI-format (.yaml). Disse spesifikasjonene kan importeres direkte til API-klienter som Bruno, slik at du kan jobbe med fullt strukturerte samlinger uten å måtte bygge forespørsler manuelt.

Trinn 1: Importer Workiva API-samlingen

1. Naviger til siden Workiva-plattformkodegenerering .
2. Last ned OpenAPI .yaml -filen.

3. Åpne Bruno. Klikk på menyen med tre prikker øverst til venstre og velg Importer samling.

   

4. Velg OpenAPI V3-fil og velg den nedlastede .yaml -filen.

   

5. Når du blir bedt om det, opprett eller velg en lokal mappe der Bruno skal lagre samlingen (for eksempel Bruno-samlinger).

   

Trinn 2: Konfigurer det globale miljøet

1. Klikk på globusikonetøverst til høyre i Bruno og velg Konfigurer.

   

2. Velg Opprett globalt miljø.
3. Opprett følgende globale variabler:
   • tilgangstoken
   • Miljø
   • Klient-ID
   • Klienthemmelighet
   • api_versjon

4. Fyll ut verdier for Miljø, KlientIDog KlientHemmelighet. La access_token stå tomt og sett api_version til 2026-01-01.

   

5. Redd miljøet.

Trinn 3: Konfigurer OAuth 2.0 – Hent et token

For å gjenbruke autentisering på tvers av flere samlinger, lagres OAuth-tilgangstokenet som en global miljøvariabel.

1. Velg Workiva API -samlingen.
2. Velg fanen Variabler.

3. Oppdater variabelen baseUrl for å bruke {{environment}} i stedet for et hardkodet domene.

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

   Oppdatert:
   https://api.{{miljø}}.wdesk.com

4. Sett autorisasjonen til Bearer Token og bruk variabelen {{access_token}}.
5. Velg fanen Skript.

6. Legg til følgende skript i delen Forhåndsforespørsel.

   For 2026 Platform API-erkreves X-Version -headeren for hver forespørsel. Dette skriptet sikrer at overskriften brukes konsekvent på tvers av samlingen, i tråd med Workivas API-versjonskrav for 2026.

   Merk: Dette kravet gjelder for øyeblikket bare for plattform-API-er.

   // Legg til eller oppdater X-versjonsheader (Bruno) req.setHeader("X-versjon", bru.getGlobalEnvVar("api_version")); 

   

7. I Workiva API-samlingen navigerer du til mappen oauth2 og åpner Hent et token.

8. I skriptdelen Post Response legger du til følgende for å lagre tokenet globalt:

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

9. Lagre endringene dine.

Trinn 4: Generer et bærertoken

1. I OAuth2-forespørselsteksten, angi:
   • {{Klient-ID}}
   • {{Klienthemmelighet}}
2. Send forespørselen Hent et token.

3. Hvis det lykkes, vil svaret inkludere et Bearer-token, og det vil bli lagret automatisk som en global variabel.

   

Du kan nå sende autentiserte forespørsler. Hvis det lykkes, vil du se dokumentlisten din returnert i svaret.

Trinn 5: Importer og konfigurer Wdata- og Chains API-samlingen

1. Gå til siden Wdata-kodegenerering.
2. Last ned .yaml -filen og importer den til Postman (Følg trinnene som er beskrevet i Trinn 1: Importer Workiva API-samlingen). Merk: Filnavnet .yaml vil sannsynligvis være det samme som Workiva API Collection.
3. I Wdata -samlingen:
   • Velg fanen Variabler.

   • Oppdater variabelen baseUrl for å bruke {{environment}} i stedet for et hardkodet domene.

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

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

   • Sett autorisasjonen til Bearer Token og bruk variabelen {{access_token}}.
   • Gjenta de samme trinnene ovenfor for Chains API Collection, og sørg for at autorisasjonsinnstillingene og baseUrl variabelen er konfigurert på samme måte.

Feilsøking

• Sørg for at du refererer til riktig miljø. Hvis samlingen har standardinnstillingen «No»-miljø, bytt til det angitte miljøet.
• Bekreft at variabelen baseUrl er konsistent på tvers av miljøet og samlingsinnstillingene.
• Sørg for å sette samlingsvariabelen baseUrl til å bruke {{environment}}; ellers kan forespørslene dine mislykkes.
• Hvis forespørselen din returnerer et 401- eller blankt svar, må du kontrollere på nytt at verdiene for klient-ID, klienthemmelighet, API_version og miljø er riktige.