Workiva kundestøttesenter

Ønsker du å koble deg 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 Connected Learning Path vil vi oppdatere kjeden vår slik at den bruker Bearer Token i en kommando som bruker endepunktet list Spreadsheets til å 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).

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 en ny arbeidsområdevariabel for URL-adressen til plattform-API-et.

1. Fra Chain Builder, naviger til Workspace Settings.
2. Under Workspace Variables klikker du på plusstegnet for å opprette en ny arbeidsområdevariabel.

3. Konfigurer variablene ved hjelp av følgende informasjon:

   • Navn: wsv-BaseURL-Platform
   • Verdi: Bruk den riktige verdien basert på din region. Du kan bekrefte regionen ved å sjekke URL-adressen; hvis URL-adressen inneholder EU eller APAC, bruker du den tilsvarende URL-adressen. Ellers bruker du den amerikanske verdien.

   Merk: US-regionen inneholder bare "app".

   • Region USA
   • EU-regionen
   • APAC-regionen

   Felt	Amerikansk verdi
   IAM Base URL	https://api.app.wdesk.com/platform/v1

   Felt	EU-verdi
   IAM Base URL	https://api.eu.wdesk.com/platform/v1

   Felt	APAC Verdi
   IAM Base URL	https://api.apac.wdesk.com/platform/v1

4. Lagre Arbeidsområdeinnstillinger.

Merk: Du bør se alle disse fire variablene i arbeidsområdeinnstillingene. Hvis ikke, kan du gå tilbake til Forutsetninger nevnt ovenfor

Trinn 2: Kopier og modifiser en kjede

1. Gå til Chain Builder og finn kjeden CLP | Generer et token.
2. Klikk på den vertikale ellipsen på høyre side, og velg Copy.
3. Når kjedekopien er opprettet, klikker du på blyantikonet for å redigere kjeden.
4. Klikk på Kjedeinnstillinger øverst til høyre.
5. Endre navn på kjeden: CLP | HTTP Request List Spreadsheets.
6. (Valgfritt) Skriv inn en Beskrivelse: "Denne kjeden genererer et nytt Workiva API Access Token. Du må oppgi en gyldig klient-ID og klienthemmelighet fra en tidligere generert API-bevilgning i variabelverdiene nedenfor. Deretter hentes en liste over alle regneark i arbeidsområdet. Arbeidsområdet ditt må ha minst ett eller flere regneark."
7. Redd kjeden.

Trinn 3: Oppgi regneark

For å hente en liste over regnearkene våre bruker denne kjeden en GET Command fra HTTP Request Connector.

4. Legg til en Get -kommando fra HTTP Request Connector i Chain-lerretet.
5. Koble Post - Retrieve a Token -kommandoen til Get -kommandoen.
6. Dobbeltklikk på kommandoen for å konfigurere den.
   1. Endre navn på kommandoen: Get - Liste over regneark
   2. Klikk på kommandoen og deretter på det tilhørende blyantikonet for å redigere kommandoen.
   3. Merk av i avmerkingsboksen Show Response.
   4. Klikk på URL og deretter på Workspace i "Velg en variabel"-panelet, og velg variabelen du opprettet i trinn 1 (wsv-BaseURL-Platform).
   5. Legg til /regneark etter variabelen.
      
      
      Vi skal nå fortelle endepunktet hvordan det skal utføres, ved å spesifisere Headers i skjemaet Get.
      Disse overskriftene vil sende Bearer Token til API-et for å vise at vi har tilgang til å hente en liste over regneark.
   6. Klikk to ganger på den grå plussknappen (+) ved siden av Header , og fyll ut hvert felt med verdiene nedenfor, og vær spesielt oppmerksom på store og små bokstaver og mellomrommet etter "Bearer".
      • Overskriftsfelt 1:
        • Nøkkel: Godta
        • Verdi: application/json
      • Topptekstfelt 2:
        • Nøkkel: Autorisasjon

        • Verdi: Bearer <Post - Hent et token - Svar>
          Erstatt <Post - Hent et token - Svar> med utdataene fra POST - Hent et token-kommandoen.

          

          1. I Velg en variabel -panelet klikker du på Runtime nedoverpilen for å utvide POST - Hent et token
          2. Klikk på nedoverpilen ved siden av Response for å utvide variabelalternativene.
          3. Velg Access_token.

7. Fyll ut Innholdstype med: application/json.

   

8. Fyll ut responsen med eksemplet på nyttelasten nedenfor. På denne måten gir vi kommandoutdataene et format som gjør det enklere å bruke hver enkelt variabel som returneres.

   { "data": [ { { "created": { "dateTime": "2018-10-21T15:03:27Z" }, "name": "Year-end review", "id": "124efa2a142f472ba1ceab34ed18915f", "modified": { "dateTime": "2018-10-21T15:03:27Z" }, "template": false }, { "created": { "dateTime": "2020-02-20T15:03:27Z" }, "name": "Q1 Review", "id": "164cfbb2b132c4623a2cfaa31ef13925a", "modified": { "dateTime": "2020-03-29T13:15:27Z" }, "template": false } ], "@nextLink": "<opaque_url>" }

9. (Valgfritt) Skriv inn en Beskrivelse: "Denne kommandoen returnerer én side i en liste med regneark. For mer informasjon, se utviklerdokumentasjonen på https://developers.workiva.com/platform-v1/platform-getspreadsheets/"

   Tips! For å finne ut hvordan du fyller ut Header- og Response-feltene, kan du se i utviklerdokumentasjonen for API-endepunktet du kobler til. I dette tilfellet bruker vi endepunktet "Get Spreadsheets".

10. Lagre kommandoen.

Trinn 4: Test øvelsen

Nå som kjeden er ferdig, kan du teste resultatet.

1. Publiser the Chain.
2. Klikk på Utfør og deretter på Kjør kjede.
3. Når kjeden er ferdig kjørt, vil du se en liste over regneark i fanen Outputs - Response Body i Get-kommandoen.

Hvis du vil fortsette å utfordre deg selv og lære mer om hvordan du bruker HTTP Request Connector til å koble til et tredjeparts API, kan du ta en titt på neste øvelse: CLP - HTTP-forespørsel Hent et enkelt regneark.