Workiva kundestøttesenter

Ønsker du å koble til en tredjepartsapplikasjon utover Workivas forhåndsbygde Premium Connectors? Du kan oppnå dette ved å bruke HTTP Request Connector Commands til å samhandle med REST API-er. 

I denne tilkoblede læringsstien skal vi opprette en kjede som autentiserer med et tredjeparts API for å hente et bærertoken. Selv om vi demonstrerer dette ved hjelp av Workiva API, kan prinsippene og prosessen brukes til å koble til diverse andre API-er.

Trinn 1: Opprett arbeidsområdevariabler

For å kunne bruke Workiva API-detaljer på tvers av flere kjeder og kommandoer, oppretter vi arbeidsområdevariabler for å lagre denne informasjonen. Vi oppretter tre arbeidsområdevariabler for følgende data: API Grant-klient-ID og klienthemmelighet, og IAM-basis-URL (identitets- og tilgangsadministrasjon).

1. Fra Kjedebyggergår du til Arbeidsområdeinnstillinger.
2. I Arbeidsområdevariablerklikker du på plusstegnet (+) tre ganger for å opprette tre arbeidsområdevariabler og konfigurerer dem som følger:
   • Variabel 1:
     • Navn: wsv-Workiva API Klient-ID
     • Verdi: Skriv inn Klient-ID-en til API-tilskuddet ditt.
       For å finne klient-ID-en, naviger til profilen din i Workiva-plattformen og finn API-tildelingen under Sikkerhet-fanen.
       Følg disse instruksjonene for mer hjelp med API-tilskudd.
   • Variabel 2:
     • Navn: wsv-Workiva API-klienthemmelighet
     • Verdi: Skriv inn Klient-ID-en til API-tilskuddet ditt.
       For å finne klienthemmeligheten, naviger til profilen din i Workiva-plattformen og finn API-tildelingen under Sikkerhet-fanen.
       Følg disse instruksjonene for mer hjelp med å finne klienthemmeligheten din

     • Klikk på låseknappen for å kryptere klienthemmeligheten din.

       Det er viktig å holde klienthemmeligheter trygge. Lagre klienthemmeligheten på et trygt sted i tilfelle du trenger tilgang til den igjen.

   • Variabel 3:

     • Navn: wsv-BaseURL-IAM
     • Verdi: Skriv inn verdien nedenfor basert på din region. Du kan bekrefte regionen ved å sjekke URL-en. Hvis URL-en inneholder EU eller APAC, bruk den tilsvarende URL-en.

     Merk: Den amerikanske regionen inneholder kun «app».

     • USA-regionen
     • EU-regionen
     • APAC-regionen

     Felt	Amerikansk verdi
     IAM-basis-URL	https://api.app.wdesk.com

     Felt	EU-verdi
     IAM-basis-URL	https://api.eu.wdesk.com

     Felt	APAC-verdi
     IAM-basis-URL	https://api.apac.wdesk.com

   • Lagre arbeidsområdeinnstillingene.

Trinn 2: Lag en kjede

For å generere Bearer-tokenet, oppretter vi en ny kjede med en POST-kommando; dette vil gi oss Bearer-tokenet vi trenger.

1. Naviger til Kjeder-fanen i Kjedebyggeren.
2. Opprett en ny kjede, og gi kjeden navnet: CLP | Generer tilgangstoken.
3. Inkluder en Beskrivelse: Denne kjeden genererer et nytt Workiva API-tilgangstoken. Du må oppgi en gyldig klient-ID og klienthemmelighet fra et tidligere generert API-tildelingsdokument i variabelverdiene nedenfor.
4. Redd kjeden.

Trinn 3: Hent en token

Denne kjeden bruker en POST -kommando fra HTTP-forespørselskoblingen for å hente Bearer-tokenet vårt. En Bearer-token er en viktig autentiseringslegitimasjon som kreves for å få tilgang til API-er. Når tokenet er innhentet i kjeden, kan det brukes i påfølgende kommandoer for å gi autorisasjon til å samhandle med API-et.

1. Legg til en Post -kommando fra HTTP Request -koblingen i startområdet.
2. Dobbeltklikk på kommandoen for å konfigurere den.
   • Gi kommandoen nytt navn: POST - Hent et token.
   • Kryss av i boksen Vis svar.
   • Fyll ut URL -feltet med URL-en til endepunktet du må nå. For å hente et token for Workiva API, fyll ut URL-en med nedenstående, og bruk arbeidsområdevariabelen til å fylle ut IAM-basis-URL-en.
     1. Klikk på URL og klikk deretter på Arbeidsområde i panelet «Velg en variabel», og velg variabelen du opprettet i trinn 1 (wsv-BaseURL-IAM).
     2. Legg til /oauth2/token etter variabelen.
   • I feltet Innholdstype skriver du inn: application/x-www-form-urlencoded.

• Bruk plusstegnet for å legge til et Header -felt.
  • Nøkkel: Godta
  • Verdi: applikasjon/json

• Bruk plusstegnet for å legge til et nytt Header -felt.
  • Nøkkel: X-versjon
  • Verdi: 2026-01-01

Vi vil fortelle endepunktet hvordan det skal utføres ved hjelp av parametere som er fylt ut i Post Form. For å gjøre det, klikk på den grønne plussknappen ved siden av skjemadelen fire ganger og fyll ut hvert felt med verdiene nedenfor. Vær spesielt oppmerksom på store og små bokstaver.

• Felt 1:
  • Navn: klient_id
  • Verdi: <wsv-Workiva API Client ID>
    I panelet Velg en variabelklikker du på pil ned for å utvide Arbeidsområde og velger wsv-Workiva API-klient-ID.
• Felt 2:
  • Navn: klienthemmelighet
  • Verdi: <wsv-Workiva API Client Secret>
    I panelet Velg en variabelklikker du på pil ned for å utvide Arbeidsområde og velger wsv-Workiva API-klienthemmelighet.
• Felt 3:
  • Navn: tilskuddstype
  • Verdi: klientlegitimasjon
• Felt 4:
  • Navn: omfang
  • Verdi: Legg eventuelt til en verdi her for å angi hvilke omfang dette tokenet skal ha tilgang til.

• Fyll ut Response med eksempelnyttelasten nedenfor. Ved å gjøre dette gir vi et format til kommandoutgangen, noe som gjør hver variabel som returneres enklere å bruke.

  { "access_token": "streng", "expires_in": "heltall", "omfang": "streng", "token_type": "streng" }

3. (Valgfritt) Skriv inn en Beskrivelse: "Denne HTTP-kommandoen utfører et POST-kall for å generere et tilgangstoken som trengs for autentisering i påfølgende HTTP-kommandoer ved hjelp av Workiva IAM API. Denne kommandoen bruker arbeidsområdevariabler til å lagre basis-URL-en for Workiva IAM API og API Grant Client ID og Client Secret. Mer informasjon finner du her: https://developers.workiva.com/2026-01-01/tokenrequest.html.
4. Lagre kommandoen.

Tupp! For å finne ut hvordan du skal fylle ut feltene Skjema og Svar, kan du se utviklerdokumentasjonen for API-endepunktet du kobler til. For Workiva API kan du finne dokumentasjonen for Bearer Token her.

Trinn 4: Test øvelsen

Nå som kjeden er fullført, test resultatet.

1. Publiser Kjeden.
2. Klikk på Utfør og deretter på Kjør kjede.

3. Når kjeden har fullført kjøringen, skal du se at tilgangstokenet er generert i Outputs-fanen - Response Body i Post -kommandoen.

   

Sjekk ut neste øvelse i læringsstien for HTTP-forespørsler for å lære hvordan du bruker Bearer-tokenet i et påfølgende kommandolisteark.