Shopify-Verbindung in Jitterbit Studio

Einführung

Eine Shopify-Verbindung, die mit dem Shopify-Connector erstellt wird, stellt den Zugriff auf Shopify her. Nach der Konfiguration einer Verbindung können Sie Instanzen von Shopify-Aktivitäten erstellen, die dieser Verbindung zugeordnet sind und entweder als Quellen (zur Bereitstellung von Daten in einem Vorgang) oder als Ziele (zur Verarbeitung von Daten in einem Vorgang) verwendet werden.

Shopify-Verbindung erstellen oder bearbeiten

Eine neue Shopify-Verbindung wird mit dem Shopify-Connector von einem dieser Orte aus erstellt:

• Die Registerkarte Projektendpunkte und Connectors der Designkomponentenpalette (siehe Designkomponentenpalette).
• Die Seite Globale Endpunkte (siehe Globalen Endpunkt erstellen in Globale Endpunkte).

Eine vorhandene Shopify-Verbindung kann von diesen Orten aus bearbeitet werden:

• Die Registerkarte Projektendpunkte und Connectors der Designkomponentenpalette (siehe Designkomponentenpalette).
• Die Registerkarte Komponenten des Projektbereichs (siehe Menü „Komponentenaktionen" in Registerkarte „Komponenten" des Projektbereichs).
• Die Seite Globale Endpunkte (siehe Globalen Endpunkt bearbeiten in Globale Endpunkte).

Shopify-Verbindung konfigurieren

Nachfolgend wird jedes Benutzeroberflächenelement des Shopify-Verbindungskonfigurationsbildschirms beschrieben.

Die in der Shopify-Verbindungskonfiguration verwendete Schnittstelle hängt von der ausgewählten Option Authentifizierungsmechanismus ab:

• Anmeldedaten-basierte Authentifizierung: Bei dieser Option wird die Verbindung mit API-Anmeldedaten für Ihren Shopify-Shop authentifiziert.

• OAuth: Bei dieser Option wird die Verbindung über Shopify in einer separaten Browserregisterkarte authentifiziert (3-legged OAuth). Diese Option erfordert die Verwendung von Agent-Version 10.83 / 11.21 oder später.

Anmeldedaten-basierte Authentifizierung

Wenn Anmeldedaten-basierte Authentifizierung als Authentifizierungsmechanismus ausgewählt ist, wird die nachfolgend beschriebene Schnittstelle angezeigt.

• Verbindungsname: Geben Sie einen Namen ein, um die Verbindung zu identifizieren. Der Name muss für jede Shopify-Verbindung eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten. Dieser Name wird auch zur Identifizierung des Shopify-Endpunkts verwendet, der sich auf eine bestimmte Verbindung und ihre Aktivitäten bezieht.

• Shop-Name: Geben Sie den Namen des Shopify-Shops ein.

• Authentifizierungsmechanismus: Wählen Sie Anmeldedaten-basierte Authentifizierung, um sich mit API-Anmeldedaten zu authentifizieren.

• Authentifizierungstyp: Wählen Sie den Authentifizierungstyp, entweder Standardauthentifizierung oder Shopify-Zugriffstoken. Wenn Sie eine private App verwenden, wählen Sie Standardauthentifizierung. Wenn Sie eine benutzerdefinierte App verwenden, die im Shopify-Admin erstellt wurde, wählen Sie Shopify-Zugriffstoken.

• API-Schlüssel: Wenn Standardauthentifizierung als Authentifizierungstyp ausgewählt wurde, geben Sie den API-Schlüssel für die Shopify-Instanz ein.

• Passwort: Wenn Standardauthentifizierung als Authentifizierungstyp ausgewählt wurde, geben Sie das Passwort für die Shopify-Instanz ein.

• API-Zugriffstoken: Wenn Shopify-Zugriffstoken als Authentifizierungstyp ausgewählt wurde, geben Sie das API-Zugriffstoken für die Shopify-Instanz ein.

• Optionale Einstellungen: Klicken Sie, um zusätzliche Einstellungen zu erweitern:

  • Proxy-Einstellungen verwenden (nur privater Agent): Bei Verwendung eines privaten Agenten kann diese Einstellung ausgewählt werden, um Proxy-Einstellungen des privaten Agenten zu verwenden.

  • API-Version: Wählen Sie die Shopify REST Admin API-Version aus. Verfügbar sind 2022-04 (Standard), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04, 2025-07, 2025-10, 2026-04 oder 2026-07. Je nach den von Shopify in der verwendeten API-Version unterstützten API-Endpunkten können die bei der Aktivitätskonfiguration verfügbaren Objekte und Unterobjekte unterschiedlich sein. Wenn Sie die API-Version für eine Verbindung mit vorhandenen konfigurierten Aktivitäten ändern, beachten Sie die zusätzlichen Überlegungen unter API-Version ändern weiter unten.

    Wichtig

    Shopify veröffentlicht alle drei Monate eine neue API-Version und unterstützt jede Releaseversion mindestens zwölf Monate lang. Sobald eine API-Version veraltet ist, wird Shopify diese Version nicht mehr unterstützen, und alle API-Aufrufe, die diese Version anfordern, werden automatisch zur ältesten derzeit unterstützten stabilen Version weitergeleitet.

    Shopify kann bestimmte Endpunkte als veraltet kennzeichnen, wenn eine neue API-Version eingeführt wird. Daher müssen Sie möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund von geänderten oder eingestellten Funktionen anpassen.

    Veraltete API-Versionen und Endpunkte werden im Shopify-Änderungsprotokoll angekündigt, wo weitere Details und relevante Migrationsinformationen verfügbar sind.

  • Request-Header: Verwenden Sie diese Tabelle, um beliebige Schlüssel-Wert-Paare hinzuzufügen, die mit jeder Aktivitätsanfrage gesendet werden. Jeder Wert, der zur Tabelle hinzugefügt wird, ist im Request-Schema jeder Aktivität enthalten.

    • Hinzufügen: Fügt eine Zeile zur Tabelle hinzu. Geben Sie für jede Eigenschaft ein Schlüssel-Wert-Paar ein.
    • Absenden: Speichert das Schlüssel-Wert-Paar in der Tabelle. Wird angezeigt, wenn Sie im Bearbeitungsmodus auf eine Zeile zeigen.
    • Verwerfen: Verwirft eine neue Zeile oder alle Änderungen an einer vorhandenen Zeile. Wird angezeigt, wenn Sie im Bearbeitungsmodus auf eine Zeile zeigen.
    • Bearbeiten: Ermöglicht das Bearbeiten eines vorhandenen Schlüssel-Wert-Paares. Wird angezeigt, wenn Sie auf eine vorhandene Zeile zeigen.
    • Löschen: Löscht die Zeile aus der Tabelle. Wird angezeigt, wenn Sie auf eine vorhandene Zeile zeigen.
    • Alle löschen: Löscht alle Zeilen aus der Tabelle.

    Wichtig

    Felder in der Tabelle Request-Header zeigen das -Variablensymbol nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit gefüllt werden, muss die Agent-Version mindestens 10.75 / 11.13 sein.

    Felder in der Tabelle Request-Header unterstützen nicht die Verwendung von Variablen zum Übergeben von Raw JSON. Wenn Ihr Anwendungsfall das direkte Definieren von Raw JSON in den Feldern nicht unterstützt, maskieren Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Beispielsweise wird {"success": "true"}; zu {\"success\": \"true\"}; maskiert.

• Test: Klicken Sie, um die Verbindung mit der bereitgestellten Konfiguration zu überprüfen. Wenn die Verbindung getestet wird, wird die neueste Version des Connectors von den Agenten in der Agentgruppe heruntergeladen, die der aktuellen Umgebung zugeordnet ist. Dieser Connector unterstützt das Aussetzen des Downloads der neuesten Connector-Version durch die Organisationsrichtlinie Automatische Connector-Aktualisierung deaktivieren .

• Speichern: Klicken Sie, um die Verbindungskonfiguration zu speichern und zu schließen.

• Änderungen verwerfen: Nachdem Sie Änderungen an einer neuen oder vorhandenen Konfiguration vorgenommen haben, klicken Sie, um die Konfiguration ohne Speichern zu schließen. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

• Löschen: Nachdem Sie eine vorhandene Verbindungskonfiguration geöffnet haben, klicken Sie, um die Verbindung dauerhaft aus dem Projekt zu löschen und die Konfiguration zu schließen (siehe Komponentenabhängigkeiten, Löschung und Entfernung). Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Verbindung löschen möchten.

OAuth

Wenn OAuth als Authentifizierungsmechanismus ausgewählt ist, wird die nachfolgend beschriebene Schnittstelle angezeigt. Wichtige Hinweise zum Verhalten von Zugriffstoken und Aktualisierungstoken finden Sie unter Wichtige Hinweise.

• Verbindungsname: Geben Sie einen Namen ein, um die Verbindung zu identifizieren. Der Name muss für jede Shopify-Verbindung eindeutig sein und darf keine Schrägstriche / oder Doppelpunkte : enthalten. Dieser Name wird auch verwendet, um den Shopify-Endpunkt zu identifizieren, der sich auf eine bestimmte Verbindung und ihre Aktivitäten bezieht.

• Speichername: Geben Sie den Shopify-Speichernamen ein. Dies ist der {shop}-Wert, der in den OAuth-URLs verwendet wird, die unter Voraussetzungen konfiguriert sind.

• Authentifizierungsmechanismus: Wählen Sie OAuth, um sich über Shopify in einem separaten Browser-Tab zu authentifizieren (3-legged OAuth). Diese Option erfordert die Verwendung von Agent-Version 10.83 / 11.21 oder später.

• OAuth-Anwendung: Verwenden Sie das Menü, um eine OAuth 2.0-Anwendung unter Private Applications auszuwählen. Diese Kategorie zeigt Shopify-Connector-Anwendungen an, die auf der Seite App Registrations der Management Console konfiguriert sind. Weitere Informationen zum Konfigurieren einer Shopify-Connector-Anwendung auf der Seite App Registrations finden Sie unter Voraussetzungen.

• Mit Shopify anmelden: Klicken Sie, um sich über Shopify in einem separaten Browser-Tab zu authentifizieren und Jitterbit die Berechtigung zum Zugriff auf den Shopify-Speicher zu erteilen.

• Optionale Einstellungen: Klicken Sie, um zusätzliche Einstellungen zu erweitern:

  • Proxy-Einstellungen verwenden (nur privater Agent): Bei Verwendung eines privaten Agenten kann diese Einstellung ausgewählt werden, um Proxy-Einstellungen des privaten Agenten zu verwenden.

  • API-Version: Wählen Sie die Shopify REST Admin API-Version aus, eine von 2022-04 (Standard), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04, 2025-07, 2025-10, 2026-04 oder 2026-07. Je nach den von Shopify in der verwendeten API-Version unterstützten API-Endpunkten können die Objekte und Unterobjekte, die während der Aktivitätskonfiguration zur Auswahl stehen, variieren. Wenn Sie die API-Version für eine Verbindung mit vorhandenen konfigurierten Aktivitäten ändern, finden Sie weitere Überlegungen unter API-Version ändern unten.

    Wichtig

    Shopify veröffentlicht alle drei Monate eine neue API-Version und verwaltet jede Releaseversion mindestens zwölf Monate lang. Sobald eine API-Version veraltet ist, wird Shopify diese Version nicht mehr verwalten, und alle API-Aufrufe, die diese Version anfordern, werden automatisch zur ältesten derzeit unterstützten stabilen Version weitergeleitet.

Shopify kann bestimmte Endpunkte mit der Einführung einer neuen API-Version einstellen. Daher müssen Sie möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund von geänderten oder eingestellten Funktionen anpassen.

Eingestellte API-Versionen und Endpunkte werden im Shopify-Änderungsprotokoll angekündigt, wo weitere Details und relevante Migrationsinformationen verfügbar sind.

• Request Headers: Verwenden Sie diese Tabelle, um beliebige Schlüssel-Wert-Paare hinzuzufügen, die mit jeder Aktivitätsanfrage gesendet werden. Jeder Wert, der zur Tabelle hinzugefügt wird, ist im Request-Schema jeder Aktivität enthalten.

  • Hinzufügen: Fügt der Tabelle eine Zeile hinzu. Geben Sie für jede Eigenschaft ein Schlüssel-Wert-Paar ein.
  • Absenden: Speichert das Schlüssel-Wert-Paar in der Tabelle. Wird angezeigt, wenn Sie den Mauszeiger im Bearbeitungsmodus über eine Zeile bewegen.
  • Verwerfen: Verwirft eine neue Zeile oder alle Änderungen an einer vorhandenen Zeile. Wird angezeigt, wenn Sie den Mauszeiger im Bearbeitungsmodus über eine Zeile bewegen.
  • Bearbeiten: Ermöglicht das Bearbeiten eines vorhandenen Schlüssel-Wert-Paars. Wird angezeigt, wenn Sie den Mauszeiger über eine vorhandene Zeile bewegen.
  • Löschen: Löscht die Zeile aus der Tabelle. Wird angezeigt, wenn Sie den Mauszeiger über eine vorhandene Zeile bewegen.
  • Alle löschen: Löscht alle Zeilen aus der Tabelle.

  Wichtig

  Felder in der Tabelle Request Headers zeigen das Variablensymbol nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit gefüllt werden, muss die Agent-Version mindestens 10.75 / 11.13 sein.

  Felder in der Tabelle Request Headers unterstützen nicht die Verwendung von Variablen zum Übergeben von Raw JSON. Wenn Ihr Anwendungsfall das direkte Definieren von Raw JSON in den Feldern nicht unterstützt, maskieren Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Beispielsweise wird {"success": "true"}; zu {\"success\": \"true\"}; maskiert.

• Test: Klicken Sie, um die Verbindung mit der bereitgestellten Konfiguration zu überprüfen. Wenn die Verbindung getestet wird, lädt der Agent (oder die Agents) in der mit der aktuellen Umgebung verknüpften Agent-Gruppe die neueste Version des Connectors herunter. Dieser Connector unterstützt das Aussetzen des Downloads der neuesten Connector-Version durch die Organisationsrichtlinie Automatisches Connector-Update deaktivieren.

• Speichern: Klicken Sie, um die Verbindungskonfiguration zu speichern und zu schließen.

• Änderungen verwerfen: Nachdem Sie Änderungen an einer neuen oder vorhandenen Konfiguration vorgenommen haben, klicken Sie, um die Konfiguration ohne Speichern zu schließen. Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Änderungen verwerfen möchten.

• Löschen: Nachdem Sie eine vorhandene Verbindungskonfiguration geöffnet haben, klicken Sie, um die Verbindung dauerhaft aus dem Projekt zu löschen und die Konfiguration zu schließen (siehe Komponentenabhängigkeiten, Löschung und Entfernung). Eine Meldung fordert Sie auf, zu bestätigen, dass Sie die Verbindung löschen möchten.

API-Version ändern

Wenn eine Shopify-Verbindung über vorhandene konfigurierte Aktivitäten verfügt, müssen beim Ändern der ausgewählten API-Version zusätzliche Aspekte berücksichtigt werden. Dies liegt daran, dass die zur Auswahl verfügbaren Objekte und Unterobjekte in der Aktivitätskonfiguration von den API-Endpunkten abhängen, die Shopify in der verwendeten API-Version unterstützt. Wenn die vorhandene Aktivitätskonfiguration API-Endpunkte verwendet, die in der API-Version, zu der Sie wechseln, nicht unterstützt werden, schlagen diese Aktivitäten fehl, es sei denn, sie werden neu konfiguriert.

Um dies zu vermeiden, führen Sie die folgenden Schritte aus:

1. Ändern Sie die API-Version in der Shopify-Verbindung.

2. Öffnen Sie jeden Aktivitätskonfigurationsbildschirm, auf dem ein Objekt oder Unterobjekt ausgewählt ist, und klicken Sie auf Aktualisieren. Bei der Aktualisierung werden die aktuellen Objekt- und Unterobjekt-Auswahlisten mit der in der Shopify-Verbindung ausgewählten API-Version abgerufen. Beachten Sie, dass Shopify Aufrufe nicht unterstützter API-Versionen automatisch zur nächsten ältesten unterstützten Version umleitet.

   Wichtig

   Wenn das ausgewählte Objekt oder Unterobjekt in der aufgerufenen API-Version nicht unterstützt wird, kann sich die Auswahl beim Aktualisieren ändern. Achten Sie genau darauf, dass alle geänderten Auswahlen wie beabsichtigt sind.

3. Wählen Sie das entsprechende Objekt und Unterobjekt aus, das von der aufgerufenen API-Version unterstützt wird.

4. Stellen Sie Operationen erneut bereit, die die Verbindung und Aktivitäten verwenden.

Nächste Schritte

Nach dem Erstellen einer Shopify-Verbindung platzieren Sie einen Aktivitätstyp auf der Design-Canvas, um Aktivitätsinstanzen zu erstellen, die entweder als Quellen (um Daten in einer Operation bereitzustellen) oder als Ziele (um Daten in einer Operation zu verarbeiten) verwendet werden.

Menüaktionen für eine Verbindung und ihre Aktivitätstypen sind über den Projektbereich und die Design-Komponentenpalette zugänglich. Weitere Informationen finden Sie unter Aktionsmenüs in Connector-Grundlagen.

Diese Aktivitätstypen sind verfügbar:

• Lesen: Ruft Objektdaten aus Shopify ab und ist für die Verwendung als Quelle in einer Operation vorgesehen.

• Abfrage: Fragt Objektdaten aus Shopify ab und ist für die Verwendung als Quelle in einer Operation vorgesehen.

• Erstellen: Erstellt Objektdaten in Shopify und ist für die Verwendung als Ziel in einer Operation vorgesehen.

• Aktualisieren: Aktualisiert Objektdaten in Shopify und ist für die Verwendung als Ziel in einer Operation vorgesehen.

• Löschen: Löscht Objektdaten aus Shopify und ist für die Verwendung als Ziel in einer Operation vorgesehen.