Workiva Support Center

Dieser Leitfaden führt Sie durch den Import von Workiva API-Sammlungen in Postman unter Verwendung von OpenAPI-Spezifikationen, der Konfiguration von Umgebungsvariablen und der Validierung von Anfragen von Anfang bis Ende.

Voraussetzungen

Bevor Sie beginnen, vergewissern Sie sich, dass Sie über die folgenden Informationen verfügen:

• Postman installiert (Version 10+ empfohlen)
• Eine gültige Workiva Client ID und Client Secret
• Zugang zu Workiva OpenAPI .yaml Dateien über das Workiva Developer Portal
• Ein Verständnis der Workiva-Umgebung, in der Sie arbeiten: app, eu, oder apac

Hintergrund

Workiva APIs werden im OpenAPI (.yaml) Format veröffentlicht. Diese Spezifikationen können direkt in Postman importiert werden, was schnellere Entwicklungs-, Test- und Integrationsabläufe ohne manuelles Erstellen von Anfragen ermöglicht.

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 Postman, wählen Sie Import, und laden Sie die heruntergeladene Datei hoch. 
   
4. Bestätigen Sie, dass eine neue Sammlung mit dem Titel Workiva API in Postman erscheint. 
   

Schritt 2: Einrichten Ihrer Umgebung

Öffnen Sie in Postman die Registerkarte Umgebungen und erstellen Sie eine neue Umgebung. Zu Testzwecken verwendet dieser Leitfaden eine Umgebung mit dem Namen <WorkspaceName>_Workiva_API.

Empfehlung: Verwenden Sie eine einheitliche Namenskonvention wie OrganizationName_WorkspaceName, um Variablen in verschiedenen Workiva-Arbeitsbereichen klar zu unterscheiden.

Fügen Sie die folgenden Variablen in der Spalte Aktueller Wert hinzu, und klicken Sie dann auf Speichern.

📘 Wie man Umgebungsvariablen in Postman verwendet

Schritt 3: OAuth2 konfigurieren - Token abrufen

1. Wählen Sie die Sammlung Workiva API.
2. Legen Sie die Autorisierung so fest, dass die Variable {{access_token}} verwendet wird.
3. Wählen Sie die Registerkarte Scripts.

4. 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 angewandt 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 pm.request.headers.upsert({ key: "X-Version", value: pm.environment.get("api_version") });

   

    

5. Wählen Sie die Registerkarte Variablen.
6. Aktualisieren Sie die Variable baseUrl, um {{environment}} anstelle einer fest codierten Domain zu verwenden.

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

Aktualisiert:
https://api.{{environment}}.wdesk.com/iam/v1

Schritt 4: Speichern des Zugangstokens

1. Wählen Sie unter Retrieve a token die Registerkarte Scripts und fügen Sie den folgenden Code in den Abschnitt Post-request ein.

   pm.test("Statuscode ist 200", function () { pm.response.to.have.status(200); }); pm.test("Zugriffstoken in Umgebungsvariable speichern", function () { var jsonData = pm.response.json(); pm.environment.set("access_token", jsonData.access_token); });

   

2. Senden Sie die Anfrage. Sie sollten eine 200 OK Antwort erhalten und Ihr access_token wird automatisch gespeichert.

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 :
   • Setzen Sie den Autorisierungstyp auf Bearer Token.

   • Verwenden Sie {{access_token}} als Token-Wert.

     

   • Aktualisieren Sie auf der Registerkarte Variablen die Variable baseUrl, um {{environment}} anstelle einer fest codierten Domäne zu verwenden. Dies erleichtert den Wechsel zwischen Umgebungen wie app, eu, oder apac.
   • Stellen Sie sicher, dass jede Anfrage auf Inherit auth from parent eingestellt ist.
   • 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.