Denne veiledningen hjelper deg med å importere Workiva API-samlinger tilBrunoved 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
- Last ned og installer Bruno frawww.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
- Naviger til sidenWorkiva-plattformkodegenerering.
- Last ned OpenAPI
oas.yaml-filen. -
ÅpneBruno. Klikk på +-ikonet øverst til venstre, og velgImporter samling.
-
Klikk på lenken «velg fil(er)» og velg den nedlastede
.yaml-filen. -
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
-
I Arbeidsområde-delen av Bruno klikker du påGlobale miljøer-fanen og deretter påOpprett miljø.
-
Skriv inn et navn for det globale miljøet ditt, og klikk deretter påOpprett.
- Opprett følgende globale variabler:
tilgangstokenKlient-IDKlienthemmelighetapi_versjon
-
Fyll ut verdier for
ClientIDogClientSecret. Laaccess_tokenstå tomt og settapi_versiontil2026-01-01. - 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.
-
VelgWorkiva API-samlingen fra arbeidsområdeområdet i Bruno.
-
Klikk på rullegardinmenyen Workiva øverst til høyre på Bruno-skjermen, og velg riktig miljø/region fra samlingslisten.
-
Klikk på fanen «Autentisering», velg «Bærertoken» fra rullegardinmenyen og angi at «Token»-feltet skal bruke variabelen
{{access_token}}. - Velg fanenSkript.
-
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.
-
I Workiva API-samlingen navigerer du til mappenoauth2 > tokenog klikker påHent et token for å åpne.
-
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); - 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
- 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.
-
- Send forespørselenHent et token.
- Hvis det lykkes, vil svaret inkludere et Bearer-token, og det vil bli lagret automatisk som englobal variabel.
Du kan nå sende autentiserte forespørsler.
VIKTIG MERKNAD: Når du bruker samlingen, endre verdien i «Autentisering»-fanen til «Arv» fra rullegardinlisten.
Hvis det lykkes, vil du se dokumentlisten din i svaret etter at du har klikket på pilen for å sende forespørselen.
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.