Vill du ansluta till en tredjepartsapplikation utöver Workivas färdiga Premium Connectors? Du kan uppnå detta genom att använda HTTP Request Connector-kommandon för att interagera med REST API:er. I den här anslutna lärvägen kommer vi att uppdatera vår kedja för att använda Bearer-token i ett kommando som använder slutpunkten för lista över kalkylblad för att ge oss en lista över kalkylblad inom arbetsytan.
Obs: Även om detta är märkt som HTTP-begäran, stöds (och rekommenderas) HTTPS (Secure HTTP).
| Primärt användningsfall för verksamheten | Ansluta till tredjepartssystem |
| Primärt lärandemål | Lär dig grundläggande kedjekoncept med hjälp av HTTP Request Connector |
| Förkunskapskrav | Konfigurera Workiva API Grant Konfigurera HTTP Request Connector CLP - HTTP-begäran Generera en token |
| Mall för support | CLP - Kalkylblad för HTTP-förfrågningslista |
Steg 1: Skapa arbetsytevariablerna
För att kunna använda Workiva API-detaljer över flera kedjor och kommandon kommer vi att skapa arbetsytevariabler för att lagra den informationen. Vi kommer att skapa en ny arbetsytevariabel för plattforms-API-URL:en.
- Från Chain Builder , navigera till Arbetsyteinställningar .
- Under Arbetsytevariabler klickar du på plustecknet för att skapa en ny arbetsytevariabel.
-
Konfigurera variablerna med hjälp av följande information:
- Namn: wsv-BaseURL-Plattform
- 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
EUellerAPAC, använd motsvarande URL. Använd annars det amerikanska värdet.
Obs: USA-regionen innehåller endast "app".
Fält Amerikanskt värde IAM-bas-URL https://api.app.wdesk.com Fält EU-värde IAM-bas-URL https://api.eu.wdesk.com Fält APAC-värde IAM-bas-URL https://api.apac.wdesk.com Fält CA-värde IAM-bas-URL https://api.ca.wdesk.com - Spara arbetsyteinställningar .
Obs! Du bör se alla dessa variabler i dina arbetsyteinställningar. Om inte, gå igenom förutsättningarna som anges ovan
Steg 2: Kopiera och modifiera en kedja
- Navigera till Chain Builder och leta reda på kedjan med namnet CLP | Generera en token .
- Klicka på den vertikala ellipsen till höger och välj Kopiera .
- När kedjekopian har skapats klickar du på pennikonen för att redigera kedjan.
- Klicka på Kedjeinställningar längst upp till höger.
- Byt namn på kedjan: CLP | Kalkylblad för HTTP-förfrågningslista .
- ( Valfritt ) Ange en beskrivning : "Denna kedja genererar en ny Workiva API-åtkomsttoken." Du måste ange ett giltigt klient-ID och en klienthemlighet från ett tidigare genererat API-tillstånd i variabelvärdena nedan. Den hämtar sedan en lista över alla kalkylblad i arbetsytan. Din arbetsyta måste ha minst ett eller flera kalkylblad.
- Rädda kedjan.
Steg 3: Lista kalkylblad
För att hämta en lista över våra kalkylblad använder den här kedjan en GET -kommandot från HTTP-förfrågningsanslutningen.
- Lägg till ett Get -kommando från HTTP-förfrågningsanslutningen till kedjearbetsytan.
- Koppla kommandot Post - Retrieve a Token till kommandot Get .
- Dubbelklicka på kommandot för att konfigurera det.
- Byt namn på kommandot: Get - Lista över kalkylblad
- Klicka på kommandot och sedan på den tillhörande pennikonen för att redigera kommandot.
- Markera kryssrutan Visa svar .
- Klicka på URL:en och sedan på Arbetsyta i panelen "Välj en variabel" och välj variabeln du skapade i steg 1 ( wsv-BaseURL-Platform ).
- Lägg till /spreadsheets efter variabeln. Vi
kommer härnäst att ange för slutpunkten hur den ska exekveras genom att ange Headers i Get- formuläret. -
Klicka på den grå plusknappen (+) bredvid rubrikavsnittet två gånger och fyll i varje fält med värdena nedan. Var särskilt uppmärksam på gemener och mellanslag efter "Bärare".
- Rubrikfält 1:
-
Använd plustecknet för att lägga till ett rubrikfält .
- Nyckel: Acceptera
- Värde : applikation/json
- Rubrikfält 2 :
-
Använd plustecknet för att lägga till ytterligare ett rubrikfält .
- Nyckel: X-version
- Värde : 2026-01-01
-
Vi kommer att tala om för slutpunkten hur den ska köras med hjälp av parametrar som är ifyllda i postformuläret . För att göra det, klicka på den gröna plusknappen bredvid formuläravsnittet fyra gånger och fyll i varje fält med värdena nedan. Var särskilt uppmärksam på att använda versaler och gemener.
-
- Fält 1:
- Namn: klient-id
- Värde: <wsv-Workiva API Client ID>
I panelen Välj en variabel klickar du på nedåtpilen för att expandera Arbetsytan och väljer wsv-Workiva API Client ID .
- Fält 2:
- Namn: klienthemlighet
- Värde: <wsv-Workiva API Client Secret>
I panelen Välj en variabel klickar du på nedåtpilen för att expandera Arbetsytan och väljer wsv-Workiva API Client Secret .
- Fält 3:
- Namn: bidragstyp
- Värde: klientuppgifter
- Fält 4:
- Namn: omfattning
- Värde: Lägg valfritt till ett värde här för att ange vilka omfång denna token ska ha åtkomst till.
- Fält 1:
- Fyll i svaret med exempelnyttolasten nedan. Genom att göra detta tillhandahåller vi ett format till kommandots utdata, vilket gör varje variabel som returneras enklare att använda.
{ "access_token": "sträng", "expires_in": "heltal", "scope": "sträng", "token_type": "sträng" }-
( Valfritt ) Ange en beskrivning : "Det här kommandot returnerar en sida i en lista med kalkylblad. För mer information, se utvecklardokumentationen på https://developers.workiva.com/2026-01-01/getspreadsheets.html
Tips! För att avgöra hur du ska fylla 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 " Hämta kalkylblad ".
- Spara kommandot.
Steg 4: Testa övningen
Nu när kedjan är klar kan du testa resultatet.
- Publicera kedjan.
- Klicka på Kör och sedan på Kör kedja .
- När kedjan har slutfört sin körning bör du se en lista med kalkylblad på fliken Utdata - Svarstext för Get-kommandot.
För att fortsätta utmana dig själv och lära dig mer om att använda HTTP Request Connector för att ansluta till ett tredjeparts-API, kolla in nästa övning: CLP - HTTP Request Get a Single Spreadsheet .