Vill du ansluta till en tredjepartsapplikation utöver Workivas färdiga Premium Connectors? Du kan uppnå detta genom att använda HTTP Request Connector Commands för att interagera med REST API:er.
I den här anslutna lärvägen kommer vi att skapa en kedja som autentiserar med ett tredjeparts-API för att hämta en bärartoken. Även om vi kommer att demonstrera detta med hjälp av Workiva API, kan principerna och processen tillämpas för att ansluta till olika andra API:er.
| Primärt användningsfall för verksamheten | Ansluta till tredjepartssystem |
| Primärt lärandemål | Lär dig grundläggande kedjekoncept och använd Workivas HTTP Request Connector-kommandon för att ansluta till och autentisera mot tredjeparts REST API:er. |
| Sekundärt lärandemål | Skapa arbetsytevariabler |
| Förkunskapskrav | Konfigurera Workiva API Grant Konfigurera HTTP Request Connector |
| Mall för support | CLP | Generera åtkomsttoken |
Steg 1: Skapa arbetsytevariabler
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 tre arbetsytevariabler för följande data: API Grant-klient-ID och klienthemlighet, och IAM-bas-URL (identitets- och åtkomsthantering).
- Från Kedjebyggarenavigerar du till Arbetsyteinställningar.
- I Arbetsytevariablerklickar du på plustecknet (+) tre gånger för att skapa tre arbetsytevariabler och konfigurerar dem enligt följande:
- Variabel 1:
- Namn: wsv-Workiva API-klient-ID
- Värde: Ange Klient-ID för ditt API-tillstånd.
För att hitta klient-ID:t, navigera till din profil i Workiva-plattformen och leta reda på API-tilldelningen under fliken Säkerhet.
Följ dessa instruktioner för mer hjälp med API-bidrag.
- Variabel 2:
- Namn: wsv-Workiva API-klienthemlighet
- Värde: Ange Klient-ID för ditt API-tillstånd.
För att hitta klienthemligheten, navigera till din profil i Workiva-plattformen och leta reda på API-tilldelningen under fliken Säkerhet.
Följ dessa instruktioner för mer hjälp med att hitta din klienthemlighet -
Klicka på låsknappen för att kryptera din klienthemlighet.
Det är viktigt att förvara klienthemligheter säkra; spara klienthemligheten på en säker plats ifall du behöver åtkomst till den igen.
-
Variabel 3:
- Namn: wsv-BaseURL-IAM
- Värde: Ange värdet nedan baserat på din region. Du kan verifiera regionen genom att kontrollera URL:en. Om URL:en innehåller
EUellerAPAC, använd motsvarande URL.
Obs: Den amerikanska 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 - Spara arbetsyteinställningarna.
- Variabel 1:
Steg 2: Skapa en kedja
För att generera Bearer-token skapar vi en ny kedja med ett POST-kommando; detta ger oss den Bearer-token vi behöver.
- Navigera till fliken Kedjor i Kedjebyggaren.
- Skapa en ny kedja och namnge kedjan: CLP | Generera åtkomsttoken.
- Inkludera en Beskrivning: Denna kedja genererar en ny Workiva API Access Token. Du måste ange ett giltigt klient-ID och en klienthemlighet från ett tidigare genererat API-tillstånd i variabelvärdena nedan.
- Rädda kedjan.
Steg 3: Hämta en token
Denna kedja använder ett POST -kommando från HTTP Request Connector för att hämta vår Bearer Token. En Bearer-token är en viktig autentiseringsuppgift som krävs för att komma åt API:er. När token väl erhållits inom kedjan kan den användas inom efterföljande kommandon för att ge behörighet att interagera med API:et.
- Lägg till ett Post -kommando från HTTP Request -anslutningen till startområdet.
- Dubbelklicka på kommandot för att konfigurera det.
- Byt namn på kommandot: POST - Hämta en token.
- Markera kryssrutan Visa svar.
- Fyll i fältet URL med URL:en för den slutpunkt du vill nå. För att hämta en token för Workiva API, fyll i URL:en med nedanstående och använd Workspace-variabeln för att fylla i IAM-bas-URL:en.
- Klicka på URL och klicka sedan på Arbetsyta i panelen "Välj en variabel" och välj variabeln du skapade i steg 1 (wsv-BaseURL-IAM).
- Lägg till /oauth2/token efter variabeln.
- I fältet Innehållstyp anger du: application/x-www-form-urlencoded.
- Använd plustecknet för att lägga till ett Header -fält.
- Nyckel: Acceptera
- Värde: applikation/json
- Använd plustecknet för att lägga till ytterligare ett Header -fält.
- Nyckel: X-version
- Värde: 2026-01-01
Vi kommer att tala om för slutpunkten hur den ska exekveras med hjälp av parametrar som är ifyllda i Post Form. 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 variabelklickar du på nedåtpilen för att expandera Arbetsyta och väljer wsv-Workiva API-klient-ID.
- Fält 2:
- Namn: klienthemlighet
- Värde: <wsv-Workiva API Client Secret>
I panelen Välj en variabelklickar du på nedåtpilen för att expandera Arbetsyta och väljer wsv-Workiva API-klienthemlighet.
- 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.
-
Fyll i Response med exempelnyttolasten nedan. Genom att göra detta tillhandahåller vi ett format till kommandots utdata, vilket gör varje returnerad variabel enklare att använda.
{ "access_token": "sträng", "expires_in": "heltal", "scope": "sträng", "token_type": "sträng" }
- (Valfritt) Ange en Beskrivning: "Detta HTTP-kommando kör ett POST-anrop för att generera en åtkomsttoken som behövs för autentisering i efterföljande HTTP-kommandon med Workiva IAM API. Det här kommandot använder arbetsytevariabler för att lagra bas-URL:en för Workiva IAM API och API Grant-klient-ID och klienthemlighet. Mer information finns här: https://developers.workiva.com/2026-01-01/tokenrequest.html.
- Spara kommandot.
Tips! För att ta reda på hur du ska fylla i fälten Formulär och Svar, se utvecklardokumentationen för den API-slutpunkt du ansluter till. För Workiva API kan du hitta dokumentationen för Bearer Token här.
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 att åtkomsttoken har genererats i fliken Utdata - Svarstext i kommandot Post.
Kolla in nästa övning i HTTP Request Connected Learning Path för att lära dig hur man använder Bearer-token i efterföljande kommandolista-kalkylblad.