CLP - HTTP-Anfrage Zugriffstoken generieren – Supportcenter

Möchten Sie eine Verbindung zu einer Anwendung eines Drittanbieters herstellen, die über die vorgefertigten Premium Connectors von Workiva hinausgeht? Dazu nutzen Sie die HTTP Request Connector-Befehle zur Interaktion mit REST-APIs.

In diesem Connected Learning Path werden wir eine Kette erstellen, die sich bei einer Drittanbieter-API authentifiziert, um ein Inhaber-Token zu erhalten. Wir werden dies anhand der Workiva-API demonstrieren, aber die Prinzipien und der Prozess können auch für die Verbindung mit verschiedenen anderen APIs angewendet werden.

Primärer geschäftlicher Anwendungsfall	Verbinden mit Systemen von Drittanbietern
Primäres Lernziel	Lernen Sie grundlegende Chains-Konzepte kennen und nutzen Sie Workivas HTTP Request Connector-Befehle, um sich mit REST-APIs von Drittanbietern zu verbinden und sich bei diesen zu authentifizieren.
Sekundäres Lernziel	Arbeitsbereich-Variablen erstellen
Voraussetzungen	Workiva API Grant konfigurieren HTTP-Request-Connector konfigurieren
Unterstützende Vorlage	CLP \| Zugriffstoken generieren

Schritt 1: Arbeitsbereich-Variablen erstellen

Um Workiva API-Details über mehrere Chains und Commands hinweg zu verwenden, erstellen wir Workspace-Variablen, um diese Informationen zu speichern. Wir werden drei Arbeitsbereich-Variablen für die folgenden Daten erstellen: API Grant Client ID und Client Secret sowie IAM (Identitäts- und Zugriffsmanagement) Base URL.

Navigieren Sie von Chain Builder zu Arbeitsbereichseinstellungen.
Klicken Sie unter Arbeitsbereich-Variablen dreimal auf das Pluszeichen (+), um drei Arbeitsbereich-Variablen zu erstellen und sie wie folgt zu konfigurieren:
- Variable 1:
  - Name: wsv-Workiva API Client ID
  - Wert: Geben Sie die Client ID Ihres API Grant ein.
    Um die Client ID zu finden, navigieren Sie zu Ihrem Profil innerhalb der Workiva Plattform und suchen Sie den API Grant auf der Registerkarte Sicherheit.
    Folgen Sie diesen Anweisungen, um mehr über API Grants zu erfahren.
- Variable 2:
  - Name: wsv-Workiva API-Client-Geheimnis
  - Wert: Geben Sie die Client ID Ihres API Grant ein.
    Um das Kundengeheimnis zu finden, navigieren Sie zu Ihrem Profil auf der Workiva Plattform und suchen Sie unter der Registerkarte Sicherheit den API Grant.
    Befolgen Sie diese Anweisungen, um Ihr Kundengeheimnis zu finden
  - Klicken Sie auf die Schaltfläche Sperren, um Ihr Kundengeheimnis zu verschlüsseln.
    
    Es ist wichtig, dass Sie Ihre Kundengeheimnisse sicher aufbewahren. Speichern Sie das Kundengeheimnis an einem sicheren Ort für den Fall, dass Sie wieder darauf zugreifen müssen.
- Variable 3:
  - Name: wsv-BaseURL-IAM
  - Wert: Geben Sie den nachstehenden Wert für Ihre Region ein. Sie können die Region überprüfen, indem Sie die URL überprüfen. Wenn die URL EU oder APAC enthält, verwenden Sie die entsprechende URL.
  Hinweis: Die US-Region enthält nur "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
- Speichern Sie die Arbeitsbereichseinstellungen.

Schritt 2: Eine Kette erstellen

Um das Inhaber-Token zu erzeugen, erstellen wir eine neue Kette mit einem POST-Befehl; so erhalten wir das benötigte Inhaber-Token.

Wechseln Sie im Chain Builder zur Registerkarte Chains.
Erstellen Sie eine neue Kette und benennen Sie sie: CLP | Zugriffstoken generieren.
Fügen Sie eine Beschreibung ein: Diese Kette generiert ein neues Workiva API Access Token. Sie müssen eine gültige Client-ID und ein gültiges Client-Geheimnis aus einem zuvor generierten API Grant in den unten stehenden Variablenwerten angeben.
Speichern Sie die Kette.

Schritt 3: Abrufen eines Tokens

Diese Kette verwendet einen POST Befehl vom HTTP Request Connector, um unser Bearer Token abzurufen. Ein Bearer Token ist ein wichtiger Authentifizierungsnachweis, der für den Zugriff auf APIs erforderlich ist. Sobald das Token innerhalb der Kette erhalten wurde, kann es in nachfolgenden Befehlen verwendet werden, um die Autorisierung für die Interaktion mit der API zu erhalten.

Fügen Sie einen Post Befehl aus dem HTTP Request Connector in den Startbereich ein.
Doppelklicken Sie auf den Befehl, um ihn zu konfigurieren.
- Benennen Sie den Befehl um: POST - Ein Token abrufen.
- Aktivieren Sie das Kontrollkästchen Antwort anzeigen.
- Füllen Sie das Feld URL mit der URL des Endpunkts, den Sie aufrufen möchten. Um ein Token für die Workiva-API abzurufen, geben Sie die URL wie folgt ein und verwenden die Workspace-Variable, um die IAM-Basis-URL zu füllen.
  1. Klicken Sie auf URL und dann auf Workspace im Bereich "Wählen Sie eine Variable" und wählen Sie die Variable, die Sie in Schritt 1 erstellt haben (wsv-BaseURL-IAM).
  2. Fügen Sie /oauth2/token nach der Variable hinzu.
- Geben Sie in das Feld Content Type ein: application/x-www-form-urlencoded.

Verwenden Sie das Zeichen Plus, um ein Feld Header hinzuzufügen.
- Schlüssel: Akzeptieren
- Wert: anwendung/json

Verwenden Sie das Zeichen Plus, um ein weiteres Feld Kopfzeile hinzuzufügen.
- Schlüssel: X-Version
- Wert: 2026-01-01

Wir teilen dem Endpunkt mit, wie er die Parameter aus dem Post Form verwenden 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>
  Klicken Sie im Feld Variable auswählen auf den Pfeil nach unten, um Arbeitsbereich zu erweitern und wählen Sie wsv-Workiva API Client ID.
Feld 2:
- Name: client_secret
- Wert: <wsv-Workiva>
  Klicken Sie im Feld Variable auswählen auf den Pfeil nach unten, um Arbeitsbereich zu erweitern und wählen Sie wsv-Workiva API Client Secret.
Feld 3:
- Name: grant_type
- Wert: client_credentials
Feld 4:
- Name: Geltungsbereich
- Wert: Fügen Sie hier optional einen Wert hinzu, um anzugeben, auf welche Bereiche dieses Token Zugriff haben soll.

Füllen Sie die Antwort mit der untenstehenden Beispiel-Nutzlast. Damit geben wir der Befehlsausgabe ein Format, das die Verwendung der einzelnen zurückgegebenen Variablen erleichtert.
```
{ "access_token": "string", "expires_in": "integer", "scope": "string", "token_type": "string" }
```

(Optional) Geben Sie eine Beschreibung ein: "Dieser HTTP-Befehl führt einen POST-Aufruf aus, um ein Zugriffs-Token zu generieren, das für die Authentifizierung in nachfolgenden HTTP-Befehlen unter Verwendung der Workiva IAM API benötigt wird. Dieser Befehl nutzt Workspace-Variablen, um die Basis-URL für die Workiva IAM API und die API Grant Client ID und Client Secret zu speichern. Weitere Informationen finden Sie hier: https://developers.workiva.com/2026-01-01/tokenrequest.html".
Speichern Sie den Befehl.

Tipp! Wie Sie die Felder Formular und Antwort ausfüllen können, entnehmen Sie bitte der Entwicklerdokumentation für den API-Endpunkt, mit dem Sie sich verbinden. Für die Workiva API finden Sie die Dokumentation zum Bearer Token hier.

Schritt 4: Testen Sie die Übung

Testen Sie nun, nachdem die Kette vollständig ist, das Ergebnis.

Veröffentlichen Sie die Kette.
Klicken Sie auf Ausführen und dann Kette ausführen.
Sobald die Kette ihren Lauf beendet hat, sollten Sie sehen, dass das Zugriffs-Token auf der Registerkarte Outputs - Response Body des Befehls Post generiert worden ist.

Schauen Sie sich die nächste Übung innerhalb des HTTP Request Connected Learning Path an, um zu lernen, wie man das Bearer Token innerhalb einer nachfolgenden Command List Spreadsheets verwendet.

Support

Community

Workiva Support Center