Workiva kundestøttesenter

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 sidenWorkiva-plattformkodegenerering.
2. Last ned OpenAPIoas.yaml-filen.

3. ÅpneBruno. Klikk på +-ikonet øverst til venstre, og velgImporter samling.

   

4. Klikk på lenken «velg fil(er)» 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../Dokumenter/Bruno).

   Du kan eventuelt endre mappeoppsettet fra «Tagger» til «Baier» og klikke på Importer.

   

Trinn 2: Konfigurer det globale miljøet

1. I Arbeidsområde-delen av Bruno klikker du påGlobale miljøer-fanen og deretter påOpprett miljø.

   

2. Skriv inn et navn for det globale miljøet ditt, og klikk deretter påOpprett.

    

3. Opprett følgende globale variabler:
   • tilgangstoken
   • Klient-ID
   • Klienthemmelighet
   • api_versjon

4. Fyll ut verdier forClientIDogClientSecret. Laaccess_tokenstå tomt og settapi_versiontil2026-01-01.

   

5. Lagre variablene.

Trinn 3: Konfigurer OAuth 2.0 – Hent et token

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

1. VelgWorkiva API-samlingen fra arbeidsområdeområdet i Bruno.

   

2. Klikk på rullegardinmenyen Workiva øverst til høyre på Bruno-skjermen, og velg riktig miljø/region fra samlingslisten.

   

3. Klikk på fanen «Autentisering», velg «Bærertoken» fra rullegardinmenyen og angi at «Token»-feltet skal bruke variabelen{{access_token}}.

   

4. Velg fanenSkript.

5. Legg til følgende skript i delenForhåndsforespørsel.

   For2026 Platform API-erkrevesX-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. Dokumentasjon finner du her: https://developers.workiva.com/2026-01-01/versioning.html

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

   

   Klikk på «Lagre»-knappen nederst til venstre i arbeidsområdet når du er ferdig.

6. I Workiva API-samlingen navigerer du til mappenoauth2 > tokenog klikker påHent et token for å åpne.

   

7. Klikk på ikonet «>>» under URL-en, og klikk på fanen «Skript».

   

   I skriptdelenPost Responselegger du til følgende for å lagre tokenet globalt:

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

8. Lagre endringene dine.

Trinn 3a (valgfritt): Importer flere Workiva API-er

Følg samme trinnsekvens ovenfor for å importere flere Workiva API-er:

wData OpenAPIoas.yamlfilen kan lastes ned fra her

Kjeder OpenAPIoas.yamlfilen kan lastes ned fra her

Trinn 4: Generer et bærertoken

1. For OAuth2-forespørselsteksten angir du følgende variabler (hvis de ikke allerede er angitt):
   • {{Klient-ID}}
   • {{Klienthemmelighet}}

     • For å angi (eller sjekke) variablene, klikk på Workiva øverst til høyre i Bruno-arbeidsområdet, klikk på fanen Global og velg «Konfigurer».

       

       Rediger variablene etter behov.

       

2. Send forespørselenHent et token.
3. Hvis det lykkes, vil svaret inkludere et Bearer-token, og det vil bli lagret automatisk som englobal variabel.

Feilsøking

• Sørg for at du refererer til riktigmiljø. Hvis samlingen har standardinnstillingen «No»-miljø, bytt tildet angitte miljøet.
• 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.