Sådan forbinder du Square med Shopify Flow
Square sender en Webhook vedrørende betalinger, ordrer, refusioner, kunder og lagerændringer på tværs af sine POS- og onlineprodukter. »Workflow Webhooks« omdanner dette kald til en »Shopify Flow«-udløser, så din butik kan reagere på det: mærke en kunde, tilføje en ordrebemærkning, sende en intern e-mail, opdatere et metafelt - alt, hvad »Shopify Flow« kan gøre.
Denne vejledning beskriver hele forløbet - Square sender, Workflow Webhooks modtager og verificerer, Shopify Flow udfører - hvor Squares HMAC-signatur kontrolleres ved hver eneste anmodning, så det er udelukkende Square, der kan igangsætte din arbejdsgang.
Hvad du kan bygge
- Tag en »Shopify«-kunde, der har købt noget i din fysiske butik via Square.
- Tilføj en bemærkning til en kunde, når der udstedes en Square-refusion, så supporten får det fulde overblik.
- Send en e-mail til personalet, når Square-lagerbeholdningen for en fælles SKU falder under en tærskelværdi.
Typiske begivenheder, der skal sendes: payment.created, refund.updated, customer.created, inventory.count.updated.
Før du går i gang
- Workflow Webhooks installeret på din Shopify-butik.
- Shopify Flow installeret, som kan hentes gratis fra App Store på Shopify.
- En konto på Square med tilladelse til at oprette webhooks.
Trin 1 - Opret webhook på Workflow Webhooks
- Åbn Workflow Webhooks -> Webhooks -> Opret webhook, og giv den et navn, du kan genkende i Shopify Flow, f.eks.
Square events. - Vælg HMAC under »Autentificering«.
- Vælg »Square« under »Signaturudbyder«. Appen udfylder overskriften, algoritmen, den signerede payload og replay-vinduet for dig - der er ikke andet, du skal konfigurere.
- Lad feltet »Secret« være tomt foreløbig, og klik på »Gem«. Kopier den webhook-URL, der vises på siden.
Se Godkendelse for de øvrige godkendelsesmetoder og Kortlægning af payload og strømningsvariabler for at vælge, hvilke felter der skal sendes til Shopify Flow.
Trin 2 - Tilføj slutpunktet i Square
I Square Developer Dashboard skal du åbne afsnittet »Webhooks« for din applikation, oprette et abonnement med den URL, du har kopieret, og kopiere signaturnøglen.
Sådan finder du din Square-adgangskode
Signaturnøglen til webhook-abonnementet (Square Developer Dashboard → Webhooks).
Squares egen dokumentation om webhook-signaturer indeholder den præcise formulering og skærmbilleder, der gælder for din konto.
Indsæt den hemmelighed i feltet »Secret« for webhooken på Workflow Webhooks og gem. Fra det øjeblik bliver hver eneste Square-levering verificeret, inden den når frem til Shopify Flow.
Hvad dette kontrollerer
| Hvad | Værdi |
|---|---|
| Signaturhoved | x-square-hmacsha256-signature |
| Hvor underskriften er placeret | Hele header-værdien |
| Hvad der er underskrevet | {url}{body} |
| Underskrift | HMAC-SHA256, base64-kodet |
| Tidspunkt | Bruges ikke af denne afsender |
| Beskyttelse mod afspilning | Ingen - denne afsender underskriver ikke tidsstemplet, så alle gyldige underskrifter forbliver gyldige |
| Hemmeligheden | Bruges som almindelig tekst. Indsæt den nøjagtigt, som afsenderen har angivet den |
I den signerede payload er {body} den rå anmodningstekst, byte for byte, og {url} er denne webhooks URL.
En anmodning, der ikke opfylder et af disse kriterier, afvises med fejlkoden »401«, registreres i »Historik og fejlfinding« og igangsætter aldrig en arbejdsgang.
Trin 3 - Opret arbejdsgangen »Shopify Flow«
- I »Shopify Flow« skal du oprette en arbejdsgang og vælge udløseren »Workflow Webhooks«.
- Tryk på »Optag begivenheder«, og send derefter en testbegivenhed fra Square (eller brug »Send test« i Workflow Webhooks), så Shopify Flow kan lære dine datas mønster at kende.
- Hver eneste webhook, du ejer, udløser den samme Shopify Flow-udløser, så tilføj en første betingelse baseret på webhook-id’et for at sikre, at denne arbejdsgang kun omfatter Square. Id’et vises på webhook-siden.
- Tilføj dine handlinger - tag en kunde, tilføj en note, send en intern e-mail, opdater et metafelt.
Trin 4 - Test det fra start til slut
Udløser en reel begivenhed i Square. Under »Workflow Webhooks« → »History« bør du kunne se opkaldet med status »Success«. Hvis signaturen var forkert, får du i stedet en fejlmeddelelse med årsagen, og på Bekræftelse af signerede webhooks finder du en forklaring til signaturtesteren, der viser dig præcis, hvilket trin der mislykkedes.
Underskriften stemmer ikke overens▾
I denne ordre: hemmeligheden (den mest almindelige årsag - et ekstra mellemrum eller en nøgle fra det forkerte miljø), om afsenderen bruger en anden endpunkts hemmelighed, og om noget mellem Square og appen omskriver brødteksten. Signaturerne dækker de rå bytes, så en proxy, der omformaterer JSON, ødelægger dem. Signaturtesteren på webhook-siden viser den nøjagtige tekst, der blev signeret.
Jeg får en 401-fejl ved hver eneste forespørgsel▾
Kontroller, at webhookens autentificering er indstillet til HMAC med Square valgt som udbyder, at den hemmelige nøgle er udfyldt, og at Square sender data til URL’en nøjagtigt som angivet i appen, inklusive koden i slutningen.
Der vises intet under »Historik«▾
Anmodningen blev aldrig modtaget. Tjek URL’en igen i Square, og se i Squares egen leveringslog, hvilket svar der blev modtaget. En 404 betyder, at webhooken er forkert eller slettet, mens en 429 betyder, at du har overskredet din planens grænse for opkald - se Planer og anvendelse.
Arbejdsgangen kører for de forkerte begivenheder▾
Hver eneste webhook i din butik udløser den samme Shopify Flow-trigger. Tilføj en betingelse baseret på webhook-id’et som det første trin i arbejdsgangen, eller begræns de hændelser, du sender fra Square.
Relateret
- Bekræftelse af signerede webhooks - alle udbydere, vi verificerer, og hvordan man beskriver en, vi ikke verificerer.
- Kortlægning af payload og strømningsvariabler - at udtrække de rigtige felter fra payloaden og overføre dem til Shopify Flow.
- Beskyttelse mod dobbeltlevering - hvad der sker, når Square forsøger at levere igen.
- Historik og fejlfinding - loggen over alle anmodninger, med mulighed for afspilning.