Workiva kundestøttesenter

Denne veiledningen hjelper deg med å importere Workiva API-samlinger til Postman ved hjelp av OpenAPI-spesifikasjoner, konfigurere miljøvariabler og validere forespørsler fra ende til ende.

Forutsetninger

Før du begynner, sørg for at du har følgende:

• Postman installert (versjon 10+ anbefalt)
• En gyldig Workiva klient-ID og klienthemmelighet
• Tilgang til Workiva OpenAPI .yaml filer via Workiva Developer Portal
• En forståelse av Workiva-miljøet du jobber i: app, eueller apac

Bakgrunn

Workiva API-er publiseres i OpenAPI-format (.yaml). Disse spesifikasjonene kan importeres direkte til Postman, noe som muliggjør raskere utviklings-, test- og integrasjonsarbeidsflyter uten å måtte konstruere forespørsler manuelt.

Trinn 1: Importer Workiva API-samlingen

1. Naviger til siden Workiva-plattformkodegenerering .
2. Last ned OpenAPI .yaml -filen. 
   
3. Åpne Postman, velg Importer, og last opp den nedlastede filen. 
   
4. Bekreft at en ny samling med tittelen Workiva API vises i Postman. 
   

Trinn 2: Konfigurer miljøet ditt

I Postman åpner du fanen Miljøer og oppretter et nytt miljø. For testformål bruker denne veiledningen et miljø som heter<WorkspaceName> _Workiva_API.

Anbefaling: Bruk en konsistent navnekonvensjon som Organisasjonsnavn_Arbeidsplassnavn for å tydelig skille variabler på tvers av ulike Workiva-arbeidsområder.

Legg til følgende variabler ved hjelp av Gjeldende verdi -kolonnen, og klikk deretter på Lagre.

📘 Hvordan bruke miljøvariabler i Postman

Trinn 3: Konfigurer OAuth2 – Hent et token

1. Velg Workiva API -samlingen.
2. Angi autorisasjon for å bruke variabelen {{access_token}}.
3. Velg fanen Skript.

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

   For 2026 Platform API-erer X-Version -headeren nødvendig på alle forespørsler. Dette skriptet sikrer at overskriften brukes konsekvent på tvers av hele 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-versjonsheaderen pm.request.headers.upsert({ key: "X-versjon", value: pm.environment.get("api_version") });

   

    

5. Velg fanen Variabler.
6. Oppdater variabelen baseUrl for å bruke {{environment}} i stedet for et hardkodet domene.

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

Oppdatert:
https://api.{{environment}}.wdesk.com/iam/v1

Trinn 4: Lagre tilgangstokenet

1. Fra Hent et token, velg fanen Skript og legg til koden nedenfor i delen Etter forespørsel.

   pm.test("Statuskoden er 200", function () { pm.response.til.ha.status(200); }); pm.test("Lagre tilgangstoken til miljøvariabel", function () { var jsonData = pm.response.json(); pm.environment.set("access_token", jsonData.access_token); });

   

2. Send forespørselen. Du skal motta et 200 OK svar, og din access_token vil bli lagret automatisk.

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:
   • Sett autorisasjonstype til Bærertoken.

   • Bruk {{access_token}} som tokenverdi.

     

   • I fanen Variabler oppdaterer du variabelen baseUrl til å bruke {{environment}} i stedet for et hardkodet domene. Dette gjør det enklere å bytte mellom miljøer som app, eueller apac.
   • Sørg for at hver forespørsel er satt til Arv godkjenning fra overordnet.
   • 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.