Welchen Plan habe ich
Suite, alle Versionen Team, Growth, Professional, Enterprise oder Enterprise Plus
Support Team, Professional oder Enterprise
Die in diesem Beitrag beschriebenen Funktionen werden vom 11. Mai bis zum 12. Juni 2026 schrittweise für alle Suite- und Support-Pläne eingeführt. Unter Umständen sind sie in Ihrem Konto noch nicht verfügbar. Weitere Informationen finden Sie in dieser Ankündigung.

Während Integrationen lange Zeit standardmäßig per REST API eingerichtet wurden, gewinnt GraphQL aufgrund seiner Flexibilität und Effizienz heute zunehmend an Bedeutung. Mit den Funktionen des Integration Builder können Sie GraphQL-APIs integrieren. Anschließend können Sie Funktionen von GraphQL nutzen, um sicherzustellen, dass nur die benötigten Daten angefordert werden, und die Verarbeitung komplexer Querys zu vereinfachen.

In diesem Beitrag wird Schritt für Schritt beschrieben, wie Sie mit dem Integration Builder eine GraphQL-Anfrage einrichten. Sie erfahren, wie das GraphQL-Schema für Querys aussieht, wie Sie eigene Querys erstellen und wie Sie Antworten in Ihre Konversationen einbinden.

So richten Sie eine GraphQL-Anfrage ein

  1. Ermitteln Sie die URL des GraphQL-Endpunkts. Sie finden sie in der Regel in der API-Dokumentation (z. B. https://api.example.com/graphql oder, für Shopify, https://{{storeName}}.myshopify.com/admin/api/2023-04/graphql.json).
  2. Fügen Sie die URL in der Oberfläche des Integration Builders hinzu.
    1. Navigieren Sie zu „Umgebungen“ und wählen Sie als Methodentyp „POST“ aus (wenn Sie Daten anfordern).
    2. Fügen Sie den GraphQL-Endpunkt in die URL-Eingabe ein.
  3. Wählen Sie die gewünschte Authentifizierungsmethode aus (falls erforderlich).
  4. Fügen Sie bei Bedarf Ihre Anmeldedaten zu den Kopfzeilen hinzu. Bei einer Shopify-Integration sieht das Ergebnis wie folgt aus:
  5. Bestimmen Sie das GraphQL-Schema zur Auswahl der Daten, die der Server zurückgeben soll.
  6. Rufen Sie das Schema vom GraphQL-Server ab.

    Das Schema definiert die verfügbaren Querys, Mutationen und Typen. Verwenden Sie Tools wie Postman, GraphQL oder Apollo Explorer, um das Schema zu untersuchen und die Query zu testen und zu verfeinern.

    Wir empfehlen, die Query in Postman abzurufen. Navigieren Sie dort zur Registerkarte „Code snippet“ und suchen Sie in den Daten nach einem Objekt mit dem Schlüssel „query“. Kopieren Sie das gewünschte Objekt, damit Sie es im nächsten Schritt verwenden können.
  7. Fügen Sie in der Registerkarte „Anfragetext“ die GraphQL-Query hinzu und geben Sie die benötigten Daten oder die Aktion an, die Sie ausführen möchten (für eine Mutationsanfrage zum Ändern von Daten: create, update, delete).
    Diese müssen im JSON-Format vorliegen.
    Beispiel für eine Query:
    {"query":"{\n __type(name: \"Order\") {\n name,\n fields {\n name\n type {\n name\n kind\n }\n }\n }\n}","variables":{}}
  8. Navigieren Sie zum Erfolgsszenario und fügen Sie Ihre Sitzungsparameter hinzu.
  9. Verwenden Sie JSONata, um die Querys für den Zugriff und (falls erforderlich) die Transformation der Daten in der Antwort zu erstellen. Beispiel:

 

Powered by Zendesk