Workiva Support Center

Diese Anleitung führt Sie durch den Import von Workiva API Sammlungen in Bruno unter Verwendung der OpenAPI Spezifikationen. Sie lernen, wie man globale Umgebungsvariablen konfiguriert, sich mit OAuth 2.0 authentifiziert und API-Anfragen von Anfang bis Ende validiert.

Voraussetzungen

1. Laden Sie Bruno von www.usebruno.com herunter und installieren Sie ihn.

Hintergrund

Workiva APIs werden im OpenAPI (.yaml) Format veröffentlicht. Diese Spezifikationen können direkt in API-Clients wie Bruno importiert werden, so dass Sie mit vollständig strukturierten Sammlungen arbeiten können, ohne Anfragen manuell erstellen zu müssen.

Schritt 1: Importieren der Workiva API Sammlung

1. Rufen Sie die Seite Workiva Platform Code Generation auf.
2. Laden Sie die OpenAPI .yaml Datei herunter.

3. Öffnen Sie Bruno. Klicken Sie in der oberen linken Ecke auf das Drei-Punkte-Menü und wählen Sie Sammlung importieren.

   

4. Wählen Sie OpenAPI V3 Datei und wählen Sie die heruntergeladene .yaml Datei.

   

5. Wenn Sie dazu aufgefordert werden, erstellen oder wählen Sie einen lokalen Ordner, in dem Bruno die Sammlung speichern wird (zum Beispiel Bruno Collections).

   

Schritt 2: Konfigurieren Sie die globale Umgebung

1. Klicken Sie in der oberen rechten Ecke von Bruno auf das Symbol Globus und wählen Sie Konfigurieren.

   

2. Wählen Sie Globale Umgebung erstellen.
3. Legen Sie die folgenden globalen Variablen an:
   • access_token
   • Umgebung
   • ClientID
   • ClientSecret
   • api_version

4. Füllen Sie die Werte für Environment, ClientID, und ClientSecret. Lassen Sie access_token leer und setzen Sie api_version auf 2026-01-01.

   

5. Retten Sie die Umwelt.

Schritt 3: OAuth 2.0 konfigurieren - Token abrufen

Um die Authentifizierung über mehrere Sammlungen hinweg wiederverwenden zu können, wird das OAuth-Zugangs-Token als globale Umgebungsvariable gespeichert.

1. Wählen Sie die Sammlung Workiva API.
2. Wählen Sie die Registerkarte Variablen.

3. Aktualisieren Sie die Variable baseUrl, um {{environment}} anstelle einer fest codierten Domain zu verwenden.

   Original:
   https://api.app.wdesk.com

   Aktualisiert:
   https://api.{{Umgebung}}.wdesk.com

4. Setzen Sie die Autorisierung auf Bearer Token und verwenden Sie die Variable {{access_token}}.
5. Wählen Sie die Registerkarte Scripts.

6. Fügen Sie das folgende Skript in den Abschnitt Pre-request ein.

   Für 2026 Platform APIs ist der X-Version Header bei jeder Anfrage erforderlich. Dieses Skript stellt sicher, dass die Kopfzeile in der gesamten Sammlung einheitlich angewendet wird, in Übereinstimmung mit Workivas 2026 API Versionierungsanforderungen.

   Hinweis: Diese Anforderung gilt derzeit nur für Plattform-APIs.

   // X-Version-Header hinzufügen oder aktualisieren (Bruno) req.setHeader("X-Version", bru.getGlobalEnvVar("api_version")); 

   

7. Navigieren Sie in der Workiva API Sammlung zum Ordner oauth2 und öffnen Sie Retrieve a token.

8. Fügen Sie im Skriptabschnitt Post Response das Folgende hinzu, um das Token global zu speichern:

   const body = res.getBody(); bru.setGlobalEnvVar("access_token", body.access_token); 

9. Speichern Sie Ihre Änderungen.

Schritt 4: Erzeugen eines Bearer Tokens

1. Setzen Sie im OAuth2-Anfragekörper:
   • {{ClientID}}
   • {{ClientSecret}}
2. Senden Sie die Anfrage Retrieve a token.

3. Bei Erfolg enthält die Antwort ein Bearer-Token und wird automatisch als globale Variable gespeichert.

   

Sie können jetzt authentifizierte Anfragen senden. Wenn die Suche erfolgreich war, wird die Dokumentenliste in der Antwort zurückgegeben.

Schritt 5: Importieren und konfigurieren Sie die Wdata- und Chains-API-Sammlung

1. Rufen Sie die Seite Wdata Code Generation auf.
2. Laden Sie die .yaml Datei herunter und importieren Sie sie in Postman (Folgen Sie den Schritten, die unter Schritt 1: Importieren der Workiva API Collection beschrieben sind). Hinweis: Der .yaml Dateiname wird wahrscheinlich derselbe sein wie der der Workiva API Collection.
3. In der Sammlung Wdata :
   • Wählen Sie die Registerkarte Variablen.

   • Aktualisieren Sie die Variable baseUrl, um {{environment}} anstelle einer fest codierten Domain zu verwenden.

     Original:
     https://h.app.wdesk.com/s/wdata/oc/api

     Aktualisiert:
     https://h.{{Umgebung}}.wdesk.com/s/wdata/prep

   • Setzen Sie die Autorisierung auf Bearer Token und verwenden Sie die Variable {{access_token}}.
   • Wiederholen Sie die obigen Schritte für die Chains API Collection und stellen Sie sicher, dass die Autorisierungseinstellungen und die Variable baseUrl auf dieselbe Weise konfiguriert sind.

Fehlersuche

• Vergewissern Sie sich, dass Sie die richtige Umgebung referenzieren. Wenn die Sammlung standardmäßig auf die Umgebung No eingestellt ist, ändern Sie sie in Ihre angegebene Umgebung.
• Vergewissern Sie sich, dass die Variable baseUrl in Ihren Umgebungs- und Kollektionseinstellungen konsistent ist.
• Stellen Sie sicher, dass die Sammelvariable baseUrl auf {{environment}} eingestellt ist; andernfalls können Ihre Anfragen fehlschlagen.
• Wenn Ihre Anfrage eine 401- oder leere Antwort zurückgibt, überprüfen Sie, ob die Werte für Client-ID, Client-Geheimnis, API_version und Umgebung korrekt sind.