Ønsker du å koble til en tredjepartsapplikasjon utover Workivas forhåndsbygde Premium Connectors? Du kan oppnå dette ved å bruke HTTP Request Connector-kommandoene til å samhandle med REST API-er. I denne tilkoblede læringsstien vil vi oppdatere kjeden vår til å bruke bærertokenet i en kommando som bruker endepunktet for liste over regneark for å gi oss en liste over regneark i arbeidsområdet.
Merk: Selv om dette er merket som HTTP-forespørsel, støttes (og anbefales) HTTPS (sikker HTTP).
| Primært forretningsbrukstilfelle | Koble til tredjepartssystemer |
| Primært læringsmål | Lær grunnleggende kjedekonsepter ved hjelp av HTTP Request Connector |
| Forutsetninger | Konfigurer Workiva API-tildeling Konfigurer HTTP-forespørselskobling CLP - HTTP-forespørsel Generer et token |
| Støttemal | CLP - Regneark med HTTP-forespørselsliste |
Trinn 1: Opprett arbeidsområdevariablene
For å kunne bruke Workiva API-detaljer på tvers av flere kjeder og kommandoer, oppretter vi arbeidsområdevariabler for å lagre denne informasjonen. Vi oppretter en ny arbeidsområdevariabel for plattform-API-URL-en.
- Fra Chain Builder navigerer du til Arbeidsområdeinnstillinger .
- Under Arbeidsområdevariabler klikker du på plusstegnet for å opprette en ny arbeidsområdevariabel.
-
Konfigurer variablene ved hjelp av følgende informasjon:
- Navn: wsv-BaseURL-Plattform
- Verdi: Bruk riktig verdi basert på regionen din. Du kan bekrefte regionen ved å sjekke URL-en. Hvis URL-en inneholder
EUellerAPAC, bruk den tilsvarende URL-en. Ellers bruk den amerikanske verdien.
Merk: USA-regionen inneholder kun «app».
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 Felt CA-verdi IAM-basis-URL https://api.ca.wdesk.com - Lagre arbeidsområdeinnstillinger .
Merk: Du bør se alle disse variablene i arbeidsområdeinnstillingene dine. Hvis ikke, gå gjennom forutsetningene nevnt ovenfor på nytt
Trinn 2: Kopier og endre en kjede
- Naviger til Chain Builder og finn kjeden som heter CLP | Generer et token .
- Klikk på den vertikale ellipsen på høyre side og velg Kopier .
- Når kjedekopien er opprettet, klikker du på blyantikonet for å redigere kjeden.
- Klikk på Kjedeinnstillinger øverst til høyre.
- Gi kjeden nytt navn: CLP | Regneark med HTTP-forespørselsliste .
- ( Valgfritt ) Skriv inn 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. Deretter henter den en liste over alle regnearkene i arbeidsområdet. Arbeidsområdet ditt må ha minst ett eller flere regneark.
- Redd kjeden.
Trinn 3: Liste over regneark
For å hente en liste over regnearkene våre, bruker denne kjeden en GET -kommandoen fra HTTP-forespørselskoblingen.
- Legg til en Get -kommando fra HTTP-forespørselskoblingen på kjedelerretet.
- Koble Post - Retrieve a Token- kommandoen til Get- kommandoen.
- Dobbeltklikk på kommandoen for å konfigurere den.
- Gi kommandoen nytt navn: Get - Liste over regneark
- Klikk på kommandoen og deretter på det tilhørende blyantikonet for å redigere kommandoen.
- Kryss av i boksen Vis svar .
- Klikk på URL-en , og klikk deretter på Arbeidsområde i panelet «Velg en variabel», og velg variabelen du opprettet i trinn 1 ( wsv-BaseURL-Platform ).
- Legg til /spreadsheets etter variabelen. Vi
vil deretter fortelle endepunktet hvordan det skal utføres, ved å spesifisere Headers i Get- skjemaet. -
Klikk på den grå plussknappen (+) ved siden av overskriftsdelen to ganger, og fyll ut hvert felt med verdiene nedenfor. Vær spesielt oppmerksom på store og små bokstaver og mellomrommet etter «Bærer».
- Topptekstfelt 1:
-
Bruk plusstegnet for å legge til et overskriftsfelt .
- Nøkkel: Godta
- Verdi : applikasjon/json
- Topptekstfelt 2 :
-
Bruk plusstegnet for å legge til et nytt overskriftsfelt .
- 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 innleggsskjemaet . 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 variabel klikker 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 variabel klikker du på pil ned for å utvide Arbeidsområde og velger wsv-Workiva API Client Secret .
- 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.
- Felt 1:
- Fyll ut svaret 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" }-
( Valgfritt ) Skriv inn en beskrivelse : "Denne kommandoen returnerer én side av en liste med regneark. For mer informasjon, se utviklerdokumentasjonen på https://developers.workiva.com/2026-01-01/getspreadsheets.html
Tupp! For å finne ut hvordan du skal fylle ut feltene Header og Response, kan du se utviklerdokumentasjonen for API-endepunktet du kobler til. I dette tilfellet bruker vi endepunktet « Hent regneark ».
- Lagre kommandoen.
Trinn 4: Test øvelsen
Nå som kjeden er fullført, test resultatet.
- Publiser kjeden.
- Klikk på Utfør og deretter på Kjør kjede .
- Når kjeden har fullført kjøringen, skal du se en liste over regneark i fanen Utdata – svarinnholdet i Get-kommandoen.
For å fortsette å utfordre deg selv og lære mer om bruk av HTTP Request Connector for å koble til et tredjeparts API, sjekk ut neste øvelse: CLP – HTTP Request Get a Single Spreadsheet .