Workiva supportcenter

Vill du ansluta till en tredjepartsapplikation utöver Workivas förbyggda Premium Connectors? Du kan uppnå detta genom att använda HTTP Request Connector-kommandon för att interagera med REST API:er. I denna Connected Learning Path kommer vi att uppdatera vår kedja för att använda Bearer Token i ett kommando som använder list Spreadsheets-slutpunkten för att ge oss en lista över kalkylblad inom arbetsytan.

Obs: Även om detta är märkt som en HTTP-förfrågan stöds (och rekommenderas) HTTPS (Secure HTTP).

Steg 1: Skapa variablerna för arbetsytan

För att kunna använda Workiva API-detaljer i flera kedjor och kommandon skapar vi arbetsytvariabler för att lagra informationen. Vi kommer att skapa en ny arbetsytavariabel för URL:en till Platform API.

1. Från Chain Builder, navigera till Workspace Settings.
2. Under Workspace Variables klickar du på plustecknet för att skapa en ny Workspace Variable.

3. Konfigurera variablerna med hjälp av följande information:

   • Namn: wsv-BaseURL-Platform
   • Värde: Använd lämpligt värde baserat på din region. Du kan verifiera regionen genom att kontrollera URL:en; om URL:en innehåller EU eller APAC, använd motsvarande URL. I annat fall används US-värdet.

   Obs: US-regionen innehåller endast "app".

   • Region USA
   • EU-regionen
   • APAC-regionen

   Fält	Värde i USA
   URL för IAM-bas	https://api.app.wdesk.com/platform/v1

   Fält	EU Värde
   URL för IAM-bas	https://api.eu.wdesk.com/platform/v1

   Fält	APAC Värde
   URL för IAM-bas	https://api.apac.wdesk.com/platform/v1

4. Spara Arbetsytans inställningar.

Obs: Du bör se alla dessa fyra variabler i dina Workspace Settings. Om inte, se över Förutsättningar som anges ovan

Steg 2: Kopiera och modifiera en kedja

1. Navigera till Chain Builder och leta upp kedjan med namnet CLP | Generera en Token.
2. Klicka på den vertikala ellipsen på höger sida och välj Kopiera.
3. När kedjekopian har skapats klickar du på pennikonen för att redigera kedjan.
4. Klicka på Kedjeinställningar längst upp till höger.
5. Byt namn på kedjan: CLP | HTTP Request List Kalkylblad.
6. (Valfritt) Ange en Beskrivning: "Denna kedja genererar en ny Workiva API Access Token. Du måste ange ett giltigt klient-ID och en giltig klienthemlighet från ett tidigare genererat API Grant i variabelvärdena nedan. Därefter hämtas en lista över alla kalkylblad inom arbetsytan. Din arbetsyta måste ha minst ett eller flera kalkylblad."
7. Rädda kedjan.

Steg 3: Lista kalkylblad

För att hämta en lista över våra kalkylblad använder den här kedjan ett GET Command från HTTP Request Connector.

4. Lägg till ett Get -kommando från HTTP Request Connector i Chain Canvas.
5. Anslut Post - Retrieve a Token Command till Get Command.
6. Dubbelklicka på kommandot för att konfigurera det.
   1. Byt namn på kommandot: Get - Lista över kalkylblad
   2. Klicka på kommandot och sedan på den tillhörande pennikonen för att redigera kommandot.
   3. Markera kryssrutan Visa svar.
   4. Klicka på URL och sedan på Workspace i panelen "Välj en variabel" och välj den variabel som du skapade i steg 1 (wsv-BaseURL-Platform).
   5. Lägg till /spreadsheets efter variabeln.
      
      
      Därefter berättar vi för slutpunkten hur den ska köras, genom att ange Headers i formuläret Get.
      Dessa Headers kommer att skicka Bearer Token till API:et för att visa att vi har tillgång till att få en lista över kalkylblad.
   6. Klicka två gånger på den grå plusknappen (+) bredvid avsnittet Header och fyll i varje fält med värdena nedan, var särskilt uppmärksam på bokstäver och mellanslag efter "Bearer".
      • Huvudfält 1:
        • Nyckel: Acceptera
        • Värde: application/json
      • Huvudfält 2:
        • Nyckel: Auktorisering

        • Värde: Bearer <Post - Retrieve a Token - Response>
          Ersätt <Post - Retrieve a Token - Response> med utdata från kommandot POST - Retrieve a Token.

          

          1. I panelen Välj en variabel klickar du på nedåtpilen Runtime för att expandera POST - Hämta en Token
          2. Klicka på nedåtpilen bredvid Response för att utöka variabelalternativen.
          3. Välj Access_token.

7. Fyll i Innehållstyp med: application/json.

   

8. Fyll i svaret med nedanstående exempel på nyttolast. Genom att göra detta ger vi kommandoutdata ett format som gör det lättare att använda varje variabel som returneras.

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

9. (Valfritt) Ange en Beskrivning: "Detta kommando returnerar en sida i en lista med kalkylblad. Mer information finns i dokumentationen för utvecklare på https://developers.workiva.com/platform-v1/platform-getspreadsheets/"

   Tips! För att avgöra hur du fyller i fälten Header och Response, kolla in utvecklardokumentationen för den API-slutpunkt du ansluter till, i det här fallet använder vi slutpunkten "Get Spreadsheets".

10. Spara kommandot.

Steg 4: Testa övningen

Nu när kedjan är klar kan du testa resultatet.

1. Publicera kedjan.
2. Klicka på Execute och sedan på Run Chain.
3. När kedjan har körts färdigt bör du se en lista över kalkylblad på fliken Outputs - Response Body i Get-kommandot.

Om du vill fortsätta att utmana dig själv och lära dig mer om hur du använder HTTP Request Connector för att ansluta till ett API från tredje part kan du kolla in nästa övning: CLP - HTTP-begäran Hämta ett enda kalkylblad.