Workiva Support Center

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 Generationauf.
2. Laden Sie die Datei OpenAPI oas.yaml herunter.

3. Öffnen Sie Bruno. Klicken Sie in der oberen linken Ecke auf das Symbol + und wählen Sie Sammlung importieren.

   

4. Klicken Sie auf den Link "Datei(en) auswählen" 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 (z. B. ../Dokumente/Bruno).

   Ändern Sie optional die Ordneranordnung von "Tags" in "Pfade" und klicken Sie auf Importieren.

   

Schritt 2: Konfigurieren Sie die globale Umgebung

1. Klicken Sie im Bereich Arbeitsbereich von Bruno auf die Registerkarte Globale Umgebungen und dann auf Umgebung erstellen.

   

2. Geben Sie einen Namen für Ihre globale Umgebung ein und klicken Sie auf Erstellen.

    

3. Legen Sie die folgenden globalen Variablen an:
   • access_token
   • ClientID
   • ClientSecret
   • api_version

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

   

5. Speichern Sie die Variablen.

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 im Bereich Arbeitsbereich von Bruno.

   

2. Klicken Sie auf das Workiva-Dropdown in der oberen rechten Ecke des Bruno-Bildschirms und wählen Sie die entsprechende Umgebung/Region aus der Sammlungsliste aus.

   

3. Klicken Sie auf die Registerkarte "Auth", wählen Sie "Bearer Token" aus der Dropdown-Liste und stellen Sie das Feld "Token" so ein, dass die Variable {{access_token}} verwendet wird.

   

4. Wählen Sie die Registerkarte Script.

5. 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. Die Dokumentation ist hier zu finden: https://developers.workiva.com/2026-01-01/versioning.html

   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")); 

   

   Klicken Sie auf die Schaltfläche "Speichern" unten links im Arbeitsbereich, wenn Sie fertig sind.

6. Navigieren Sie in der Workiva API Sammlung zum Ordner oauth2 > token und klicken Sie auf Retrieve a token um diesen zu öffnen.

   

7. Klicken Sie auf das Symbol ">>" unter der Url und klicken Sie auf die Registerkarte "Script".

   

   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); 

8. Speichern Sie Ihre Änderungen.

Schritt 3a (optional): Zusätzliche Workiva APIs importieren

Um weitere Workiva-APIs zu importieren, gehen Sie in derselben Reihenfolge vor wie oben beschrieben:

wData OpenAPI oas.yaml Datei kann von hier heruntergeladen werden

Chains OpenAPI oas.yaml Datei kann von hier heruntergeladen werden

Schritt 4: Erzeugen eines Bearer Tokens

1. Setzen Sie für den OAuth2-Anfragekörper die folgenden Variablen (sofern sie nicht bereits gesetzt sind):
   • {{ClientID}}
   • {{ClientSecret}}

     • Um die Variablen zu setzen (oder zu überprüfen), klicken Sie auf Workiva in der oberen rechten Ecke des Bruno-Arbeitsbereichs, klicken Sie auf die Registerkarte Global und wählen Sie "Konfigurieren".

       

       Bearbeiten Sie die Variablen, falls erforderlich.

       

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.

Fehlersuche

• Vergewissern Sie sich, dass Sie auf die richtige Umgebung verweisen. Wenn die Sammlung standardmäßig auf die Umgebung No eingestellt ist, ändern Sie sie auf Ihre angegebene Umgebung.
• 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.