Möchten Sie eine Verbindung zu einer Anwendung eines Drittanbieters herstellen, die über die vorgefertigten Premium Connectors von Workiva hinausgeht? Sie können dies erreichen, indem Sie die HTTP Request Connector-Befehle zur Interaktion mit REST-APIs nutzen. In diesem Connected Learning Path werden wir unsere Kette aktualisieren, um das Bearer Token in einem Befehl zu verwenden, der den Endpunkt list Spreadsheets verwendet, um uns eine Liste der Spreadsheets im Workspace zu liefern.
Hinweis: Obwohl dies als HTTP-Anfrage bezeichnet wird, wird HTTPS (Secure HTTP) unterstützt (und empfohlen).
| Primärer geschäftlicher Anwendungsfall | Verbinden mit Systemen von Drittanbietern |
| Primäres Lernziel | Erlernen grundlegender Chains-Konzepte mit dem HTTP Request Connector |
| Voraussetzungen | Workiva-API-Berechtigung konfigurieren HTTP-Request-Konnektor konfigurieren CLP – HTTP-Request Token generieren |
| Unterstützende Vorlage | CLP - HTTP-Anfrageliste Tabellenkalkulationen |
Schritt 1: Erstellen Sie die Workspace-Variablen
Um Workiva-API-Details über mehrere Ketten und Befehle hinweg zu verwenden, erstellen wir Workspace-Variablen, um diese Informationen zu speichern. Wir erstellen eine neue Arbeitsbereich-Variable für die Plattform-API-URL.
- Wechseln Sie in Chain Builder zu den Arbeitsbereichseinstellungen .
- Klicken Sie unter „Workspace-Variablen“ auf das Pluszeichen, um eine neue Workspace-Variable zu erstellen.
-
Konfigurieren Sie die Variablen unter Verwendung der folgenden Informationen:
- Name: wsv-BaseURL-Platform
- Wert: Verwenden Sie je nach Region den entsprechenden Wert. Sie können die Region anhand der URL überprüfen; wenn die URL „
EU“ oder „APAC“ enthält, verwenden Sie die entsprechende URL. Andernfalls verwenden Sie den US-Wert.
Hinweis: Die Region „USA“ enthält ausschließlich „App“.
Feld US-Wert IAM-Basis-URL https://api.app.wdesk.com Feld EU Wert IAM-Basis-URL https://api.eu.wdesk.com Feld APAC Wert IAM-Basis-URL https://api.apac.wdesk.com Feld CA-Wert IAM-Basis-URL https://api.ca.wdesk.com - Arbeitsbereichseinstellungen speichern.
Hinweis: Alle diese Variablen sollten in Ihren Arbeitsbereichseinstellungen angezeigt werden. Falls nicht, gehen Sie noch einmal die oben genannten Voraussetzungen durch.
Schritt 2: Kopieren und Ändern einer Kette
- Gehen Sie zu „Chain Builder“ und suchen Sie die Kette mit dem Namen „CLP | Generate a Token “.
- Klicken Sie auf die vertikale Ellipse auf der rechten Seite und wählen Sie „Kopieren“ aus.
- Sobald die Kopie der Kette erstellt wurde, klicken Sie auf das Bleistiftsymbol, um die Kette zu bearbeiten.
- Klicken Sie oben rechts auf „Ketteneinstellungen “.
- Kette umbenennen: CLP | Tabellen mit HTTP-Anfragen .
- ( Optional ) Geben Sie eine Beschreibung ein: „Diese Kette generiert ein neues Workiva-API-Zugriffstoken.“ Sie müssen eine gültige Client-ID und ein gültiges Client-Geheimnis aus einer zuvor generierten API-Berechtigung in die unten stehenden Variablenwerte eingeben. Es ruft dann eine Liste aller Tabellenkalkulationen innerhalb des Arbeitsbereichs ab. Ihr Arbeitsbereich muss mindestens eine oder mehrere Tabellenkalkulationen enthalten."
- Speichern Sie die Kette.
Schritt 3: Tabellenkalkulationen auflisten
Um eine Liste unserer Tabellen abzurufen, verwendet diese Kette eine GET -Befehl aus dem HTTP-Request-Konnektor.
- Fügen Sie dem Ketten-Arbeitsbereich einen „Get“-Befehl aus dem HTTP-Request-Konnektor hinzu.
- Verbinden Sie den Befehl „Post – Token abrufen “ mit dem Befehl „Get “.
- Doppelklicken Sie auf den Befehl, um ihn zu konfigurieren.
- Befehl umbenennen: Get – Liste der Tabellenkalkulationen
- Klicken Sie auf den Befehl und dann auf das zugehörige Bleistiftsymbol, um den Befehl zu bearbeiten.
- Aktivieren Sie das Kontrollkästchen „Antwort anzeigen “.
- Klicken Sie auf „URL“ und anschließend im Bereich „Variable auswählen“ auf „Workspace“ und wählen Sie die Variable aus, die Sie in Schritt 1 erstellt haben ( wsv-BaseURL-Platform ).
- Füge hinter der Variablen „/spreadsheets “ hinzu. Als Nächstes
legen wir dem Endpunkt fest, wie er die Anfrage ausführen soll, indem wir Header im GET-Format angeben. - Klicken Sie zweimal auf die graue Plus-Schaltfläche (+) neben dem Abschnitt „Header“ und geben Sie in jedes Feld die unten angegebenen Werte ein. Achten Sie dabei besonders auf die Groß- und Kleinschreibung sowie auf das Leerzeichen nach „Bearer“.
- Kopfzeilenfeld 1:
-
Verwenden Sie das Pluszeichen , um ein Kopfzeilenfeld hinzuzufügen.
- Legende: Akzeptieren
- Wert : application/json
- Kopfzeilenfeld 2 :
-
Verwenden Sie das Pluszeichen , um ein weiteres Kopfzeilenfeld hinzuzufügen.
- Legende: X-Version
- Wert : 01.01.2026
-
Wir werden dem Endpunkt mitteilen, wie er die Ausführung anhand der in das Post-Formular eingegebenen Parameter durchführen soll. Klicken Sie dazu 4 Mal auf die grüne Plus-Schaltfläche neben dem Abschnitt Formular und geben Sie in jedes Feld die unten stehenden Werte ein, wobei Sie besonders auf die Groß- und Kleinschreibung achten müssen.
-
- Feld 1:
- Name: client_id
- Wert: <wsv-Workiva API Client ID>
Klicken Sie im Bereich „Variable auswählen“ auf den Abwärtspfeil, um „Workspace“ zu erweitern, und wählen Sie „wsv-Workiva API Client ID“ aus.
- Feld 2:
- Name: client_secret
- Wert: <wsv-Workiva API Client Secret>
Klicken Sie im Bereich „Variable auswählen“ auf den Abwärtspfeil, um „Workspace“ zu erweitern, und wählen Sie „wsv-Workiva API Client Secret“ aus.
- Feld 3:
- Name: grant_type
- Wert: client_credentials
- Feld 4:
- Name: scope
- Wert: Geben Sie hier optional einen Wert ein, um festzulegen, auf welche Bereiche dieses Token Zugriff haben soll.
- Feld 1:
- Füllen Sie die Antwort mit der unten stehenden Beispiel-Nutzlast. Auf diese Weise geben wir der Befehlsausgabe ein Format, so dass jede zurückgegebene Variable einfacher zu verwenden ist.
{ "access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }-
( Optional ) Geben Sie eine Beschreibung ein: „Dieser Befehl gibt eine Seite einer Liste von Tabellenkalkulationen zurück.“ Weitere Informationen finden Sie in der Entwicklerdokumentation unter https://developers.workiva.com/2026-01-01/getspreadsheets.html
Tipp! Um zu erfahren, wie die Felder „Header“ und „Response“ ausgefüllt werden müssen, lesen Sie bitte die Entwicklerdokumentation für den API-Endpunkt, mit dem Sie eine Verbindung herstellen. In diesem Fall verwenden wir den Endpunkt „Get Spreadsheets “.
- Speichern Sie den Befehl.
Schritt 4: Testen Sie die Übung
Testen Sie nun, nachdem die Kette vollständig ist, das Ergebnis.
- Die Blockchain veröffentlichen .
- Klicken Sie auf „Ausführen “ und anschließend auf „Kette ausführen “.
- Sobald die Kette ihre Ausführung abgeschlossen hat, sollte auf der Registerkarte „Outputs“ – im Antworttext des Get-Befehls – eine Liste von Tabellenkalkulationen angezeigt werden.
Wenn Sie sich weiterhin neuen Herausforderungen stellen und mehr über die Verwendung des HTTP-Request-Konnektors zum Herstellen einer Verbindung zu einer API eines Drittanbieters erfahren möchten, sehen Sie sich die nächste Übung an: CLP – HTTP-Request: Abrufen einer einzelnen Tabelle .