Så här kopplar du ihop Square med Shopify Flow
Koppla Square till Shopify Flow med Workflow Webhooks och verifierad HMAC. Tagga kunder, lägg till anteckningar och skicka e-post vid betalningar.
Square skickar en webhook för betalningar, beställningar, återbetalningar, kunder och lagerförändringar via sina kassasystem och onlineprodukter. Workflow Webhooks omvandlar detta anrop till en Shopify Flow-utlösare, så att din butik kan reagera på det: märka en kund, lägga till en beställningsanteckning, skicka ett internt e-postmeddelande, uppdatera ett metafält - allt som Shopify Flow kan göra.
Den här guiden beskriver hela processen - Square skickar, Workflow Webhooks tar emot och verifierar, Shopify Flow utför åtgärder - där Squares HMAC-signatur kontrolleras vid varje förfrågan, så att endast Square kan sätta igång ditt arbetsflöde.
Vad du kan bygga
- Tagga en Shopify-kund som har handlat i din fysiska butik via Square.
- Lägg till en anteckning om kunden när en återbetalning via Square görs, så att supporten får en fullständig bild av situationen.
- Skicka ett e-postmeddelande till personalen när lagernivån för en delad SKU hos Square sjunker under ett tröskelvärde.
Vanliga händelser som ska skickas: payment.created, refund.updated, customer.created, inventory.count.updated.
Innan du börjar
- Workflow Webhooks-funktioner som är installerade i din Shopify-butik.
- Shopify Flow är installerat, vilket är gratis att hämta från Shopify App Store.
- Ett konto på Square med behörighet att skapa webhooks.
Steg 1 - Skapa webhooken i Workflow Webhooks
- Öppna ”Workflow Webhooks”** -> ”Webhooks” -> ”Skapa webhook”** och ge den ett namn som du känner igen i Shopify Flow, till exempel
Square events. - Under ”Autentisering” väljer du HMAC.
- Under ”Signaturleverantör” väljer du Square. Appen fyller i rubriken, algoritmen, den signerade datan och återuppspelningsfönstret åt dig - det finns inget annat att konfigurera.
- Lämna fältet för hemligheten tomt för tillfället och klicka på Spara. Kopiera webhook-URL:en som visas på sidan.
Se Autentisering för övriga autentiseringslägen och Kartläggning av nyttolast och Shopify Flow-variabler för information om hur du väljer vilka fält som ska skickas till Shopify Flow.
Steg 2 - Lägg till betalningsmottagaren i Square
Öppna avsnittet ”Webhooks” för din applikation i Square Developer Dashboard, lägg till en prenumeration med den URL du kopierade och kopiera signaturnyckeln.
Så här hittar du din hemliga kod för Square-inloggning
Signaturnyckeln för webhook-prenumerationen (Square Developer Dashboard → Webhooks).
Squares egen dokumentation om webhook-signaturer innehåller den exakta formuleringen och skärmdumpar för just ditt konto.
Klistra in den hemliga koden i fältet ”Secret” för webhooken i Workflow Webhooks och spara. Från och med då verifieras varje Square-leverans innan den når Shopify Flow.
Vad detta kontrollerar
| Vad | Värde |
|---|---|
| Signaturrubrik | x-square-hmacsha256-signature |
| Var signaturen ska placeras | Hela värdet i rubriken |
| Vad som har undertecknats | {url}{body} |
| Signatur | HMAC-SHA256, Base64-kodad |
| Tidsstämpel | Används inte av denna avsändare |
| Skydd mot uppspelning | Ingen - den här avsändaren signerar inte tidsstämpeln, så alla giltiga signaturer förblir giltiga |
| Hemligheten | Används som ren text. Klistra in den exakt så som avsändaren visar den |
I den signerade dataposten är {body} den obearbetade begäran, byte för byte, och {url} är webhookens URL.
En begäran som inte uppfyller något av dessa krav avvisas med 401, registreras i Historik och felsökning och startar aldrig ett arbetsflöde.
Steg 3 - Skapa arbetsflödet i Shopify Flow
- I Shopify Flow skapar du ett arbetsflöde och väljer utlösaren ”Workflow Webhooks”.
- Klicka på ”Spela in händelser” och skicka sedan en testhändelse från Square (eller använd funktionen ”Skicka test” i ”Workflow Webhooks”) så att Shopify Flow lär sig hur dina data ser ut.
- Varje webhook som du äger aktiverar samma utlösare i Shopify Flow, så lägg till ett första villkor baserat på webhook-id:t för att begränsa detta arbetsflöde till endast Square. Id:t visas på webhook-sidan.
- Lägg till dina åtgärder - märk en kund, lägg till en anteckning, skicka ett internt e-postmeddelande, uppdatera ett metafält.
Steg 4 - Testa systemet från början till slut
Utlös en verklig händelse i Square. Under ”Workflow Webhooks” → ”History” bör du se anropet med statusen ”Success”. Om signaturen var felaktig visas istället en post om misslyckande med orsaken angiven, och Verifiering av signerade webhooks förklarar signaturtestaren som visar exakt vilket steg som misslyckades.
Signaturen stämmer inte överens
I följande ordning: hemligheten (den vanligaste orsaken - ett extra mellanslag eller en nyckel från fel miljö), om avsändaren använder en annan ändpunkts hemlighet, och om något mellan Square och appen skriver om huvudtexten. Signaturerna omfattar de råa byte, så en proxy som omformaterar JSON gör dem ogiltiga. Signaturtestaren på webhook-sidan visar exakt den text som signerades.
Jag får felkod 401 vid varje förfrågan
Kontrollera att webhookens autentisering är inställd på HMAC med Square som vald leverantör, att den hemliga nyckeln är ifylld och att Square skickar data till URL:en exakt så som den visas i appen, inklusive koden i slutet.
Det visas inget i historiken
Begäran kom aldrig fram. Kontrollera URL-adressen i Square igen och titta i Squares egen leveranslogg för att se vilket svar som mottogs. Ett 404-fel innebär att webhooken är felaktig eller har tagits bort, medan ett 429-fel innebär att du har överskridit antalet anrop som ingår i ditt abonnemang - se Planer och användning.
Arbetsflödet körs för fel händelser
Varje webhook i din butik utlöser samma utlösare i Shopify Flow. Lägg till ett villkor baserat på webhook-ID:t som det första steget i arbetsflödet, eller begränsa vilka händelser du skickar från Square.
Relaterat
- Verifiering av signerade webhooks - alla leverantörer som vi verifierar, samt hur man beskriver en leverantör som vi inte verifierar.
- Kartläggning av nyttolast och Shopify Flow-variabler - att hämta rätt fält från payloaden och överföra dem till Shopify Flow.
- Skydd mot dubbla leveranser - vad som händer när Square gör ett nytt leveransförsök.
- Historik och felsökning - loggen över varje förfrågan, med möjlighet att spela upp den.