Workiva Support Center

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 gekennzeichnet ist, wird HTTPS (Secure HTTP) unterstützt (und empfohlen).

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.

1. Navigieren Sie von Chain Builder zu Arbeitsbereichseinstellungen.
2. Klicken Sie unter Arbeitsbereich-Variablen auf das Pluszeichen, um eine neue Arbeitsbereich-Variable zu erstellen.

3. Konfigurieren Sie die Variablen unter Verwendung der folgenden Informationen:

   • Name: wsv-BaseURL-Plattform
   • Wert: Verwenden Sie je nach Region den entsprechenden Wert. 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. Andernfalls verwenden Sie den US-Wert.

   Hinweis: US-Region enthält nur "app".

   • Region USA
   • Region EU
   • Region APAC

   Feld	US-Wert
   IAM-Basis-URL	https://api.app.wdesk.com/platform/v1

   Feld	EU Wert
   IAM-Basis-URL	https://api.eu.wdesk.com/platform/v1

   Feld	APAC Wert
   IAM-Basis-URL	https://api.apac.wdesk.com/platform/v1

4. Arbeitsbereichseinstellungen speichern.

Hinweis: Sie sollten alle vier dieser Variablen in Ihren Arbeitsbereichseinstellungen sehen.  Falls nicht, lesen Sie noch einmal die oben genannten Voraussetzungen

Schritt 2: Kopieren und Ändern einer Kette

1. Navigieren Sie zum Chain Builder und suchen Sie die Kette mit dem Namen CLP | Generate a Token.
2. Klicken Sie auf die vertikale Ellipse auf der rechten Seite und wählen Sie Kopieren.
3. Sobald die Kopie der Kette erstellt wurde, klicken Sie auf das Bleistiftsymbol, um die Kette zu bearbeiten.
4. Klicken Sie oben rechts auf Ketteneinstellungen.
5. Benennen Sie die Kette um: CLP | HTTP-Anfrageliste Tabellenkalkulationen.
6. (Optional) Geben 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 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."
7. Speichern Sie die Kette.

Schritt 3: Tabellenkalkulationen auflisten

Um eine Liste unserer Tabellenkalkulationen abzurufen, verwendet diese Kette einen GET Befehl vom HTTP Request Connector.

4. Fügen Sie einen Get Befehl aus dem HTTP Request Connector in das Chain Canvas ein.
5. Verbinden Sie den Post - Retrieve a Token Befehl mit dem Get Befehl.
6. Doppelklicken Sie auf den Befehl, um ihn zu konfigurieren.
   1. Benennen Sie den Befehl um: Hole - Liste der Tabellenkalkulationen
   2. Klicken Sie auf den Befehl und dann auf das zugehörige Bleistiftsymbol, um den Befehl zu bearbeiten.
   3. Aktivieren Sie das Kontrollkästchen Antwort anzeigen.
   4. Klicken Sie auf URL und dann auf Arbeitsbereich im Bereich "Wählen Sie eine Variable" und wählen Sie die Variable, die Sie in Schritt 1 erstellt haben (wsv-BaseURL-Platform).
   5. Fügen Sie /spreadsheets nach der Variablen hinzu.  
      
      
      Als nächstes teilen wir dem Endpunkt mit, wie er ausgeführt werden soll, indem wir Headers im Formular Get angeben. 
      Diese Kopfzeilen übergeben das Bearer Token an die API, um zu zeigen, dass wir Zugriff auf eine Liste von Tabellenkalkulationen haben.
   6. Klicken Sie zweimal auf die graue Plus-Schaltfläche (+) neben dem Abschnitt Kopfzeile und geben Sie in jedes Feld die unten stehenden Werte ein. Achten Sie dabei besonders auf die Groß- und Kleinschreibung und das Leerzeichen nach "Überbringer".
      • Kopfzeilenfeld 1:
        • Schlüssel: Akzeptieren
        • Wert: application/json
      • Kopfzeilenfeld 2:
        • Schlüssel: Autorisierung

        • Wert: Bearer <Post>
          Ersetzen Sie <Post> durch die Ausgabe des Befehls POST - Retrieve a Token.

          

          1. Klicken Sie im Bereich Wählen Sie eine Variable auf den Abwärtspfeil Laufzeit, um POST - Abrufen eines Tokens zu erweitern.
          2. Klicken Sie auf den Abwärtspfeil neben Antwort, um die Variablenoptionen zu erweitern.
          3. Wählen Sie Access_token.

7. Füllen Sie Inhaltstyp mit: application/json.

   

8. 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.

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

9. (Optional) Geben Sie eine Beschreibung ein: "Dieser Befehl gibt eine Seite einer Liste von Tabellenkalkulationsblättern zurück. Weitere Informationen finden Sie in der Entwicklerdokumentation unter https://developers.workiva.com/platform-v1/platform-getspreadsheets/"

   Tipp! Um herauszufinden, wie Sie die Felder Header und Response ausfüllen, lesen Sie die Entwicklerdokumentation für den API-Endpunkt, mit dem Sie sich verbinden. In diesem Fall verwenden wir den Endpunkt "Get Spreadsheets".

10. Speichern Sie den Befehl.

Schritt 4: Testen Sie die Übung

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

1. Veröffentlichen Sie die Kette.
2. Klicken Sie auf Ausführen und dann Kette ausführen.
3. Sobald die Kette ihren Lauf beendet hat, sollten Sie auf der Registerkarte Outputs - Response Body des Befehls Get eine Liste der Tabellenkalkulationen sehen.

Um sich selbst weiter herauszufordern und mehr über die Verwendung des HTTP Request Connectors zur Verbindung mit einer Drittanbieter-API zu erfahren, sehen Sie sich die nächste Übung an: CLP - HTTP-Anfrage Abrufen eines einzelnen Arbeitsblatts.