So verbinden Sie Shopify mit Shopify Flow

Q: Die Signatur stimmt nicht überein

In dieser Reihenfolge: das Geheimnis (die häufigste Ursache - ein zusätzliches Leerzeichen oder ein Schlüssel aus der falschen Umgebung), ob der Absender das Geheimnis eines anderen Endpunkts verwendet und ob irgendetwas zwischen Shopify und der App den Hauptteil umschreibt . Signaturen beziehen sich auf die Rohbytes, sodass ein Proxy, der JSON neu formatiert, diese Signaturen ungültig macht. Der Signatur-Tester auf der Webhook-Seite zeigt den genauen Text an, der signiert wurde.

Shopify signiert seine eigenen Webhooks und App-zu-App-Aufrufe mit dem API-Geheimschlüssel Ihrer App. Mit dieser Voreinstellung können Sie einen Webhook von einem anderen Shopify-Shop oder von Ihrer eigenen App empfangen und ihn genau so verifizieren, wie es in der Dokumentation unter Shopify beschrieben ist. „Workflow Webhooks“ wandelt diesen Aufruf in einen „Shopify Flow“-Trigger um, sodass Ihr Shop darauf reagieren kann: einen Kunden kennzeichnen, eine Bestellnotiz hinzufügen, eine interne E-Mail versenden, ein Metafeld aktualisieren - alles, was Shopify Flow leisten kann.

Diese Anleitung legt den gesamten Ablauf fest - Shopify sendet, Workflow Webhooks empfängt und überprüft, Shopify Flow führt die Aktion aus -, wobei bei jeder Anfrage die HMAC-Signatur von Shopify überprüft wird, sodass ausschließlich Shopify Ihren Workflow starten kann.

Was Sie bauen können

Spiegeln Sie eine Bestellung aus einem zweiten Shopify-Shop in diesen Shop: Markieren Sie den Kunden, fügen Sie eine Notiz hinzu oder starten Sie einen Fulfillment-Workflow.
Reagieren Sie in Shopify Flow auf ein Thema, das Shopify Flow selbst nicht als Trigger anbietet, indem Sie es über Ihre eigene App abonnieren.
Stellen Sie sicher, dass Groß- und Einzel-Shops reibungslos zusammenarbeiten, ohne einen Middleware-Dienst programmieren zu müssen.

Typische Ereignisse, die gesendet werden sollten: orders/create, products/update, customers/create, fulfillments/create.

Bevor Sie beginnen

Workflow Webhooks in Ihrem Shopify-Shop installiert.
Shopify Flow installiert, die kostenlos im App Store unter Shopify erhältlich ist.
Ein Konto auf Shopify mit der Berechtigung, Webhooks zu erstellen.

Schritt 1 - Erstellen Sie den Webhook unter Workflow Webhooks

Öffnen Sie „Workflow Webhooks“** -> „Webhooks“ -> „Webhook erstellen“** und geben Sie ihm einen Namen, den Sie in Shopify Flow wiedererkennen, beispielsweise Shopify events.
Wählen Sie unter „Authentifizierung“ die Option „HMAC“ aus.
Wählen Sie unter „Signaturanbieter“ die Option „Shopify“ aus. Die App füllt die Felder „Header“, „Algorithmus“, „signierte Payload“ und „Wiederholungsfenster“ automatisch für Sie aus - es sind keine weiteren Einstellungen erforderlich.
Lassen Sie das Feld „Secret“ vorerst leer und klicken Sie auf „Speichern“. Kopieren Sie die auf der Seite angezeigte Webhook-URL.

Informationen zu den anderen Authentifizierungsmodi finden Sie unter Authentifizierung, und unter Zuordnung der Payload-Daten und Flow-Variablen erfahren Sie, welche Felder an Shopify Flow übermittelt werden.

Schritt 2 - Fügen Sie den Endpunkt unter Shopify hinzu

Richten Sie das Webhook-Abonnement im sendenden Shop oder in der App mit der von Ihnen kopierten URL ein und signieren Sie es mit dem API-Geheimschlüssel dieser App.

So finden Sie Ihr Signaturgeheimnis für Shopify

Der API-Schlüssel Ihrer App / der Signaturschlüssel für den Webhook.

Die Dokumentation von Shopify zu Webhook-Signaturen enthält den genauen Wortlaut und Screenshots für Ihr Konto.

Fügen Sie diesen Schlüssel in das Feld „Secret“ des Webhooks unter Workflow Webhooks ein und speichern Sie die Eingabe. Ab diesem Zeitpunkt wird jede Zustellung von Shopify überprüft, bevor sie Shopify Flow erreicht.

Was hier überprüft wird

Was	Wert
Signaturzeile	`X-Shopify-Hmac-Sha256`
Wo sich die Unterschrift befindet	Der gesamte Wert des Headers
Was wurde unterzeichnet?	`{body}`
Unterschrift	HMAC-SHA256, Base64-kodiert
Zeitstempel	Wird von diesem Absender nicht verwendet
Wiedergabeschutz	Keine - dieser Absender versieht den Zeitstempel nicht mit einer Signatur, sodass jede gültige Signatur ihre Gültigkeit behält
Das Geheimnis	Wird als Klartext verwendet. Fügen Sie den Text genau so ein, wie er vom Absender angegeben wird.

In der signierten Payload entspricht {body} byteweise dem Rohtext des Anfragetextkörpers.

Eine Anfrage, die eine dieser Bedingungen nicht erfüllt, wird mit dem Fehler 401 abgelehnt, unter Hintergrund und Fehlerbehebung protokolliert und löst niemals einen Workflow aus.

Schritt 3 - Erstellen Sie den Workflow Shopify Flow

Erstellen Sie in „Shopify Flow“ einen Workflow und wählen Sie den Trigger „Workflow Webhooks“ aus.
Klicken Sie auf „Ereignisse aufzeichnen“ und senden Sie anschließend ein Testereignis über Shopify (oder verwenden Sie die Option „Test senden“ unter Workflow Webhooks), damit Shopify Flow die Struktur Ihrer Daten erkennt.
Jeder Webhook, den Sie besitzen, löst denselben Shopify Flow-Trigger aus. Fügen Sie daher eine erste Bedingung für die Webhook-ID hinzu, um diesen Workflow ausschließlich auf Shopify zu beschränken. Die ID wird auf der Webhook-Seite angezeigt.
Fügen Sie Ihre Aktionen hinzu - kennzeichnen Sie einen Kunden, fügen Sie eine Notiz hinzu, versenden Sie eine interne E-Mail, aktualisieren Sie ein Metafeld.

Eine Shopify Flow-Bedingung: Die Webhook-ID entspricht der ID eines Webhooks — Der erste Schritt jedes Workflows: eine Bedingung bezüglich der Webhook-ID, damit der Workflow nur für diesen Webhook ausgeführt wird.

Der fertige Workflow: Webhook-Trigger, eine Bedingung basierend auf der Webhook-ID, anschließend „Interne E-Mail senden“ im „True“-Zweig — Der fertige Workflow: Trigger, Bedingung anhand der Webhook-ID, anschließend Ihre Aktion im „True“-Zweig.

Schritt 4 - Testen Sie das System von Anfang bis Ende

Lösen Sie ein echtes Ereignis in Shopify aus. Unter „Workflow Webhooks“ → „History“ sollten Sie den Aufruf mit dem Status „Success“ sehen. Sollte die Signatur fehlerhaft sein, erhalten Sie stattdessen einen fehlgeschlagenen Eintrag mit der entsprechenden Begründung, und unter Überprüfung signierter Webhooks finden Sie Erläuterungen zum Signatur-Tester, der Ihnen genau anzeigt, welcher Schritt fehlgeschlagen ist.

Ein Aufruf wurde im Protokoll „History“ mit seinen Anforderungsheadern, der Payload, dem Status, der Dauer und den Kennungen aufgezeichnet. — Ein in „History“ übermittelter Vorgang: Der Status „Erfolgreich“ bedeutet, dass Shopify Flow diesen akzeptiert hat.

Die Signatur stimmt nicht überein▾

In dieser Reihenfolge: das Geheimnis (die häufigste Ursache - ein zusätzliches Leerzeichen oder ein Schlüssel aus der falschen Umgebung), ob der Absender das Geheimnis eines anderen Endpunkts verwendet und ob irgendetwas zwischen Shopify und der App den Hauptteil umschreibt. Signaturen beziehen sich auf die Rohbytes, sodass ein Proxy, der JSON neu formatiert, diese Signaturen ungültig macht. Der Signatur-Tester auf der Webhook-Seite zeigt den genauen Text an, der signiert wurde.

Bei jeder Anfrage erhalte ich den Fehlercode 401▾

Bitte überprüfen Sie, ob die Authentifizierung des Webhooks auf „HMAC“ eingestellt ist und der Anbieter „Shopify“ ausgewählt wurde, ob das Geheimnis eingegeben wurde und ob Shopify genau die URL verwendet, wie sie in der App angezeigt wird, einschließlich des Codes am Ende.

Im Verlauf wird nichts angezeigt▾

Die Anfrage ist nie angekommen. Überprüfen Sie die URL erneut unter Shopify und sehen Sie sich im Zustellungsprotokoll von Shopify an, welche Antwort dort eingegangen ist. Ein 404 bedeutet, dass der Webhook falsch ist oder gelöscht wurde; ein 429 bedeutet, dass Sie das Aufruflimit Ihres Plans überschritten haben - siehe Pläne und Nutzung.

Der Workflow wird bei den falschen Ereignissen ausgeführt▾

Jeder Webhook in Ihrem Shop löst denselben Shopify Flow-Trigger aus. Fügen Sie als ersten Schritt des Workflows eine Bedingung für die Webhook-ID hinzu oder schränken Sie die Ereignisse ein, die Sie über Shopify senden.