Shopify-Verbindung im Jitterbit Studio

Einführung

Eine Shopify-Verbindung, die mit dem Shopify-Connector erstellt wurde, ermöglicht den Zugriff auf Shopify. Sobald eine Verbindung konfiguriert ist, können Instanzen von Shopify-Aktivitäten erstellt werden, die mit dieser Verbindung verknüpft sind, um entweder als Quellen (um Daten in einem Vorgang bereitzustellen) oder als Ziele (um Daten in einem Vorgang zu konsumieren) verwendet zu werden.

Erstellen oder Bearbeiten einer Shopify-Verbindung

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

• Der Registerkarte Projektendpunkte und -connectoren in der Designkomponenten-Palette (siehe Designkomponenten-Palette).
• Der Seite Globale Endpunkte (siehe Einen globalen Endpunkt erstellen in Globale Endpunkte).

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

• Der Registerkarte Projektendpunkte und -connectoren in der Designkomponenten-Palette (siehe Designkomponenten-Palette).
• Der Registerkarte Komponenten im Projektbereich (siehe Aktionsmenü für Komponenten in Projektbereich Komponenten-Registerkarte).
• Der Seite Globale Endpunkte (siehe Einen globalen Endpunkt bearbeiten in Globale Endpunkte).

Konfigurieren einer Shopify-Verbindung

Jedes Benutzeroberflächenelement des Konfigurationsbildschirms für die Shopify-Verbindung wird im Folgenden beschrieben.

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

• Credential-based Auth: Bei dieser Option wird die Verbindung mit API-Anmeldeinformationen für Ihren Shopify-Shop authentifiziert.

• OAuth: Bei dieser Option wird die Verbindung über Shopify in einem separaten Browser-Tab (3-legged OAuth) authentifiziert. Diese Option erfordert die Verwendung der Agenten-Version 10.83 / 11.21 oder höher.

Credential-based Auth

Wenn Credential-based Auth als Authentifizierungsmechanismus ausgewählt ist, wird die unten 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 verwendet, um den Shopify-Endpunkt zu identifizieren, der sich sowohl auf eine spezifische Verbindung als auch auf deren Aktivitäten bezieht.

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

• Authentifizierungsmechanismus: Wählen Sie Credential-based Auth, um sich mit API-Anmeldeinformationen zu authentifizieren.

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

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

• Passwort: Wenn Basic-Authentifizierung 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 Agents kann diese Einstellung ausgewählt werden, um die Proxy-Einstellungen des privaten Agents zu verwenden.

  • API-Version: Wählen Sie die Version der Shopify REST Admin API, eine der 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 oder 2026-04. 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 die API-Version für eine Verbindung geändert wird, die bereits konfigurierte Aktivitäten hat, beachten Sie die zusätzlichen Überlegungen in Ändern der API-Version unten.

    Wichtig

    Shopify veröffentlicht alle drei Monate eine neue API-Version und pflegt jede Veröffentlichungsversion mindestens zwölf Monate lang. Sobald eine API-Version eingestellt wird, wird Shopify diese Version nicht mehr pflegen, und alle API-Aufrufe, die diese Version anfordern, werden automatisch auf die älteste derzeit unterstützte stabile Version umgeleitet.

    Shopify kann bestimmte Endpunkte einstellen, wenn eine neue API-Version eingeführt wird. Daher müssen Sie möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund geänderter oder eingestellter Funktionen anpassen.

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

  • Anforderungsheader: Verwenden Sie diese Tabelle, um Schlüssel-Wert-Paare hinzuzufügen, die mit jeder Aktivitätsanfrage gesendet werden. Jeder in die Tabelle eingefügte Wert wird im Anfrageschema jeder Aktivität enthalten.

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

    Wichtig

    Felder in der Tabelle Anforderungsheader zeigen das Variablen-Icon nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit befüllt werden, muss die Agenten-Version mindestens 10.75 / 11.13 sein.

    Felder in der Tabelle Anforderungsheader unterstützen nicht die Verwendung von Variablen, um rohes JSON zu übergeben. Wenn Ihr Anwendungsfall nicht unterstützt, rohes JSON direkt in den Feldern zu definieren, entkommen Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Zum Beispiel wird das Entkommen von {"success": "true"}; zu {\"success\": \"true\"};.

• 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 Agentengruppe heruntergeladen, die mit der aktuellen Umgebung verbunden ist. Dieser Connector unterstützt das Aussetzen des Downloads der neuesten Connector-Version durch die Verwendung der Organisation Richtlinie Automatische Connector-Aktualisierung deaktivieren.

• Änderungen speichern: Klicken Sie, um die Konfiguration der Verbindung zu speichern und zu schließen.

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

• Löschen: Nachdem Sie eine bestehende Verbindungs-Konfiguration 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 Nachricht fordert Sie auf, zu bestätigen, dass Sie die Verbindung löschen möchten.

OAuth

Wenn OAuth als Authentifizierungsmechanismus ausgewählt ist, wird die unten beschriebene Schnittstelle angezeigt. Für wichtige Hinweise zum Verhalten von Zugriffstoken und Aktualisierungstoken siehe 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 sowohl auf eine bestimmte Verbindung als auch auf deren Aktivitäten bezieht.

• Shop-Name: Geben Sie den Namen des Shopify-Shops ein. Dies ist der {shop} Wert, der in den OAuth-URLs verwendet wird, die in Voraussetzungen konfiguriert sind.

• Authentifizierungsmechanismus: Wählen Sie OAuth, um sich über Shopify in einem separaten Browser-Tab zu authentifizieren (3-beiniger OAuth). Diese Option erfordert die Verwendung der Agentenversion 10.83 / 11.21 oder höher.

• OAuth-Anwendung: Verwenden Sie das Menü, um eine OAuth 2.0-Anwendung unter Private Anwendungen auszuwählen. Diese Kategorie zeigt die in der Management-Konsole konfigurierten Shopify-Connector-Anwendungen auf der Seite App-Registrierungen an. Weitere Informationen zur Konfiguration einer Shopify-Connector-Anwendung auf der Seite App-Registrierungen finden Sie unter Voraussetzungen.

• Mit Shopify anmelden: Klicken Sie, um sich über Shopify in einem separaten Browser-Tab zu authentifizieren und Jitterbit die Zustimmung zu erteilen, auf den Shopify-Shop zuzugreifen.

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

  • Proxy-Einstellungen verwenden (Nur privater Agent): Wenn Sie einen privaten Agenten verwenden, kann diese Einstellung ausgewählt werden, um private Agenten-Proxy-Einstellungen zu verwenden.

  • API-Version: Wählen Sie die Version der Shopify REST Admin API, eine der 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 oder 2026-04. 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 die API-Version für eine Verbindung mit bereits konfigurierten Aktivitäten geändert wird, siehe zusätzliche Überlegungen in Ändern der API-Version unten.

    Wichtig

    Shopify veröffentlicht alle drei Monate eine neue API-Version und pflegt jede Veröffentlichungsversion mindestens zwölf Monate lang. Sobald eine API-Version eingestellt wird, wird Shopify diese Version nicht mehr pflegen, und alle API-Aufrufe, die diese Version anfordern, werden automatisch an die älteste derzeit unterstützte stabile Version weitergeleitet.

    Shopify kann bestimmte Endpunkte mit der Einführung einer neuen API-Version einstellen. Daher müssen möglicherweise Ihre Apps und Aktivitätskonfigurationen aufgrund geänderter oder eingestellter Funktionen angepasst werden.

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

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

    • Hinzufügen: Fügt der Tabelle eine Zeile hinzu. Geben Sie ein Schlüssel-Wert-Paar für jede Eigenschaft ein.
    • Einreichen: Speichert das Schlüssel-Wert-Paar in der Tabelle. Sichtbar beim Überfahren einer Zeile im Bearbeitungsmodus.
    • Verwerfen: Verwirft eine neue Zeile oder Änderungen an einer bestehenden Zeile. Sichtbar beim Überfahren einer Zeile im Bearbeitungsmodus.
    • Bearbeiten: Ermöglicht das Bearbeiten eines bestehenden Schlüssel-Wert-Paares. Sichtbar beim Überfahren einer bestehenden Zeile.
    • Löschen: Löscht die Zeile aus der Tabelle. Sichtbar beim Überfahren einer bestehenden Zeile.
    • Alle löschen: Löscht alle Zeilen aus der Tabelle.

    Wichtig

    Felder in der Tabelle Anforderungsheader zeigen das Variablen-Icon nur im Bearbeitungsmodus an. Damit die Variablenwerte dieser Felder zur Laufzeit befüllt werden, muss die Agenten-Version mindestens 10.75 / 11.13 sein.

    Felder in der Tabelle Anforderungsheader unterstützen nicht die Verwendung von Variablen, um rohes JSON zu übergeben. Wenn Ihr Anwendungsfall nicht unterstützt, rohes JSON direkt in den Feldern zu definieren, entkommen Sie den JSON-Inhalt, bevor Sie ihn mit einer Variablen übergeben. Zum Beispiel wird das Entkommen von {"success": "true"}; zu {\"success\": \"true\"};.

• 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 Agentengruppe heruntergeladen, die mit der aktuellen Umgebung verbunden ist. Dieser Connector unterstützt das Aussetzen des Downloads der neuesten Connector-Version durch die Verwendung der Organisationseinstellung Automatische Connector-Aktualisierung deaktivieren.

• Änderungen speichern: Klicken Sie, um die Konfigurationsänderungen zu speichern und die Verbindung zu schließen.

• Änderungen verwerfen: Nachdem Sie Änderungen an einer neuen oder bestehenden Konfiguration vorgenommen haben, klicken Sie, um die Konfiguration ohne Speichern zu schließen. Eine Nachricht fragt Sie, ob Sie die Änderungen wirklich verwerfen möchten.

• Löschen: Nachdem Sie eine bestehende Verbindungs-Konfiguration 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 Nachricht fragt Sie, ob Sie die Verbindung wirklich löschen möchten.

Ändern der API-Version

Wenn eine Shopify-Verbindung bereits konfigurierte Aktivitäten hat, sind zusätzliche Überlegungen erforderlich, wenn die ausgewählte API-Version geändert wird. Das liegt daran, dass die in der Aktivitätskonfiguration verfügbaren Objekte und Unterobjekte von den API-Endpunkten abhängen, die von Shopify in der verwendeten API-Version unterstützt werden. Wenn die bestehende Aktivitätskonfiguration API-Endpunkte verwendet, die in der API-Version, zu der Sie wechseln, nicht unterstützt werden, werden diese Aktivitäten fehlschlagen, es sei denn, sie werden neu konfiguriert.

Um dies zu verhindern, befolgen Sie diese Schritte:

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

2. Öffnen Sie jeden Bildschirm der Aktivitätskonfiguration, in dem ein Objekt oder Unterobjekt ausgewählt ist, und klicken Sie auf Aktualisieren. Bei der Aktualisierung werden die aktuellen Listen der Objekt- und Unterobjektauswahl mithilfe der in der Shopify-Verbindung ausgewählten API-Version abgerufen. Beachten Sie, dass Shopify automatisch Aufrufe von nicht unterstützten API-Versionen auf die nächstältere unterstützte Version umleitet.

   Wichtig

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

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

4. Neu bereitstellen von Operationen unter Verwendung der Verbindung und Aktivitäten.

Nächste Schritte

Nachdem eine Shopify-Verbindung erstellt wurde, platzieren Sie einen Aktivitätstyp auf der Entwurfskanvas, um Aktivitätsinstanzen zu erstellen, die entweder als Quellen (um Daten in einem Vorgang bereitzustellen) oder als Ziele (um Daten in einem Vorgang zu konsumieren) verwendet werden.

Menüaktionen für eine Verbindung und ihre Aktivitätstypen sind im Projektbereich und in der Palette der Entwurfskomponenten zugänglich. Für Details siehe Aktionsmenüs in Connector-Grundlagen.

Diese Aktivitätstypen sind verfügbar:

• Lesen: Ruft Objektdaten von Shopify ab und ist als Quelle in einem Vorgang vorgesehen.

• Abfragen: Abfragt Objektdaten von Shopify und ist als Quelle in einem Vorgang vorgesehen.

• Erstellen: Erstellt Objektdaten in Shopify und ist als Ziel in einem Vorgang vorgesehen.

• Aktualisieren: Aktualisiert Objektdaten in Shopify und ist als Ziel in einem Vorgang vorgesehen.

• Löschen: Löscht Objektdaten von Shopify und ist als Ziel in einem Vorgang vorgesehen.