GraphQL

Zweck

Der GraphQL Connector ermöglicht die universelle Interaktion mit beliebigen GraphQL-APIs. Er sendet Abfragen (queries) zum Abrufen und Mutationen (mutations) zum Erstellen oder Ändern von Daten an einen GraphQL-Server und unterstützt so flexible Automatisierungen mit modernen Diensten.

Praktische Anwendungshinweise

1. Automatische Anfrageformatierung: GraphQL-Abfrage-String und optionale Variablen werden automatisch in den standardmäßigen GraphQL-JSON-Body ({"query": "...", "variables": {...}}) verpackt und per POST gesendet.

2. Operationsname: Optionaler operationName zur Identifikation der spezifischen Operation, hilfreich bei Debugging und Logging.

3. Header: Eigene Header können hinzugefügt werden, z. B. für Authentifizierung.

Authentifizierung

Unterstützt mehrere Methoden:

1

Keine Authentifizierung

Für öffentliche GraphQL-Endpunkte.

2

Bearer Token

Sendet Bearer-Token im Authorization-Header.

• token: Das Bearer-Token.

3

API-Schlüssel

Fügt Schlüssel-Wert-Paar in Header oder Query-Parameter ein.

• key: Name des API-Schlüssels (z. B. x-api-key)

• value: Wert des API-Schlüssels

• addTo: headers oder queryParameters

4

OAuth2-Passwort

OAuth 2.0 Password Grant zur Tokenbeschaffung.

• Username: Dienst-Benutzername

• Password: Dienst-Passwort

• Token URL: Token-Endpunkt-URL

• Client ID: Client-ID der Anwendung

• Body Field: Übertragungsart der Anmeldedaten (form_params oder json)

Erwartungen an Ein- und Ausgabe

Eingabe

1. Query: Vollständige GraphQL-Abfrage oder -Mutation (Pflichtfeld).

2. Variables: Optionaler JSON-formatierter String mit Abfragevariablen, z. B.:

{"id": "123", "status": "active"}

1. Operation Name: Optionaler String zur Identifikation einer spezifischen Operation bei mehreren.

Ausgabe

1. response: Enthält die vollständige JSON-Antwort des GraphQL-Servers. Erfolgreiche Antworten enthalten meist einen data-Schlüssel, Fehler einen errors-Schlüssel.

2. header: Antwort-Header, wenn „Header ausgeben“ aktiviert ist.

3. createResponseDataStructure: Aktion zur Erstellung einer strukturierten Ausgabe zur einfacheren Nutzung in Workflow-Schritten.