Workiva Support Center

Bei dynamischen Integrationen, insbesondere bei der Verwendung von HTTP Konnektoren in Automatisierungen (z.B. Chains), ist es entscheidend, die Antwort eines API-Aufrufs effektiv zu behandeln. Mit Ausgabeparametern können Benutzer wichtige Daten erfassen, die von der API zurückgegeben werden - wie den Antwortkörper, die Kopfzeilen der Antwort und den Statuscode -, so dass diese Daten in nachgelagerten Schritten verwendet werden können.

Welches Problem wird damit gelöst?

Ausgabeparameter sind entscheidend für die Erstellung reaktionsschneller und intelligenter Arbeitsabläufe.

• Dynamische Arbeitsabläufe: Mit Ausgabeparametern können Sie die nächsten Schritte auf der Grundlage der von der API zurückgegebenen Daten anpassen - zum Beispiel ein Token extrahieren, prüfen, ob ein Datensatz vorhanden ist, oder einen erfolgreichen Vorgang bestätigen.
• Automatisierungen: Durch die automatische Erfassung von Werten vermeiden Benutzer manuelle Eingaben oder harte Kodierung, wodurch Workflows mit weniger Wartungsaufwand skaliert werden können.
• Optimierte Integrationen: Die Verbindung von Systemen wie Authentifizierungsservern, CRMs oder benutzerdefinierten APIs wird nahtloser, da sich der Konnektor auf der Grundlage der empfangenen Daten anpasst.

Wer ist davon betroffen?

• Entwickler und Integratoren: Diejenigen, die Automatisierungsketten oder Integrationen zwischen Systemen aufbauen.
• Daten-Analysten: Diejenigen, die sich auf genaue Datenflüsse in Echtzeit verlassen, um Dashboards oder Berichte zu erstellen.
• System-Administratoren: Diejenigen, die Integrationen pflegen und Fehler beheben - der Zugriff auf die Ausgabeparameter hilft, Probleme schnell zu erkennen.

Was sind Ausgabe-Parameter?

Die Ausgabeparameter in einem HTTP Konnektor werden verwendet, um die erwarteten Ausgaben einer HTTP-Anfrage zu definieren, wie z.B. Antwort-Kopfzeilen, Antwort-Body oder Antwort-Code. Diese definieren die erwarteten Ergebnisse einer HTTP-Anfrage, die dann in nachfolgenden Knoten oder Logikschritten in einer Kette wiederverwendet werden können.

Beispiel Ausgabe-Parameter:

• Kopfzeilen der Antwort: Metadaten wie Inhaltstyp, Server oder Grenzwert-Status.
• Response Body: Der tatsächliche Inhalt, der von der API zurückgegeben wird – normalerweise im JSON- oder XML-Format.
• Antwort Code: Zeigt Erfolg (200), Client-Fehler (400), Server-Fehler (500) usw. an.

Beispiel: Erfassen eines Zugangstokens

Angenommen, eine API gibt ein Token wie dieses zurück:

{ "token_type": "Bearer", "expires_in": 600, "access_token": "<access_token_string>", "scope": "graph:write graph_api|r permissions|w ..." }

Sie können access_token als Ausgabeparameter definieren und ihn dann an den nächsten Schritt übergeben (z.B. um einen anderen API-Aufruf zu authentifizieren).

Warum wird der Response Body benötigt?

Im Antwortkörper gibt die API normalerweise die wichtigsten Informationen zurück. Diese können einschließen, sind aber nicht begrenzt auf:

• IDs von neu erstellten Datensätzen
• Token für die Authentifizierung
• Abfrageergebnisse oder Daten-Payloads

Ohne Zugriff auf den Antwortkörper sind Sie auf Metadaten beschränkt, was die Dynamik Ihres Workflows einschränkt. 

Wir können nun den access_token unter der Dropdown-Liste Antwort abrufen.

Häufige Fehlerbehandlungsszenarien

Typische Probleme, die bei der Arbeit mit Ausgabeparametern auftreten können:

• Fehler: undefinierte Ausgabeparameter

  Ursache & Behebung: Die Struktur des Antwortkörpers hat sich geändert oder ist verschachtelt. Bestätigen Sie den korrekten JSON-Pfad zu dem Feld.

• Fehler: 401 Nicht autorisiert

  Ursache & Behebung: Token fehlt oder ist abgelaufen. Stellen Sie sicher, dass das Token ordnungsgemäß erfasst und weitergegeben wird.

• Fehler: 500 Interner Serverfehler

  Ursache & Behebung: Serverproblem oder ungültige Nutzdaten der Anfrage. Im Response Body finden Sie weitere Informationen.

• Fehler: Ungültiges JSON

  Ursache & Behebung: Die API gibt eine missgestaltete Antwort zurück. Verwenden Sie einen Try-Catch-Block oder validieren Sie die Ausgabe vor dem Parsen.

Was ist ein Bearer-Token und warum wird er benötigt?

Ein Bearer-Token ist eine Art von Zugriffstoken, der in der OAuth 2.0-Authentifizierung verwendet wird. Sie autorisiert einen Benutzer oder eine Anwendung, auf eine API zuzugreifen. Es wird "Bearer" genannt, weil Sie das Token in der Kopfzeile Ihrer HTTP-Anfrage "tragen".

Beispiel-Kopfzeile:

Autorisierung: Bearer <access_token>

Dieses Token ist sicherer als die Basisauthentifizierung, weil:

• Sie läuft ab, wodurch das Risiko von Token-Lecks verringert wird.
• Sie kann Geltungsbereiche und Berechtigungen enthalten.
• Es trennt die Authentifizierung von der Autorisierung.

Warum nicht einfach die Basisauthentifizierung verwenden?

Während die Basisauthentifizierung einen Benutzernamen und ein Passwort verschlüsselt in jeder Anfrage sendet, treten folgende Unzulänglichkeiten auf:

• Ist weniger sicher - Anmeldedaten können wiederverwendet oder abgefangen werden.
• Der Zugriff kann nicht einfach verfallen oder eingeschränkt werden.
• Es fehlt eine Token-basierte Berechtigungskontrolle.

Bearer-Tokens unterstützen den Ablauf von Token, die Aktualisierung und granulare Berechtigungen, was sie zu einer besseren Wahl für moderne APIs und unternehmensgerechte Sicherheit macht.