Slik kobler du Square til Shopify Flow
Koble Square til Shopify Flow med Workflow Webhooks og HMAC-verifisering. Utløs tagger, notater, e-poster og metafelt fra betalinger og refusjoner.
Square sender en webhook for betalinger, bestillinger, refusjoner, kunder og endringer i lagerbeholdningen fra både sine kassesystemer og nettbaserte produkter. Workflow Webhooks omdanner dette anropet til en utløser i Shopify Flow, slik at nettbutikken din kan reagere på det: merke en kunde, legge til en bestillingsmerknad, sende en intern e-post, oppdatere et metafelt - alt det Shopify Flow kan gjøre.
Denne veiledningen beskriver hele prosessen - Square sender, Workflow Webhooks mottar og verifiserer, Shopify Flow utfører - med Squares HMAC-signatur sjekket ved hver forespørsel, slik at kun Square kan sette i gang arbeidsflyten din.
Hva du kan bygge
- Merk en Shopify-kunde som har kjøpt noe i din fysiske butikk via Square.
- Legg til en merknad til en kunde når det utstedes en Square-tilbakebetaling, slik at kundestøtten får et fullstendig bilde av situasjonen.
- Send en e-post til personalet når lagerbeholdningen i Square for en delt SKU faller under en terskelverdi.
Typiske hendelser som skal sendes: payment.created, refund.updated, customer.created, inventory.count.updated.
Før du begynner
- Workflow Webhooks-funksjonen er installert i din Shopify-butikk.
- Shopify Flow er installert - den er gratis å laste ned fra Shopify App Store.
- En konto på Square med tillatelse til å opprette webhooks.
Trinn 1 - Opprett webhooken i Workflow Webhooks
- Åpne Workflow Webhooks → Webhooks → Opprett webhook og gi den et navn du vil kjenne igjen i Shopify Flow, for eksempel
Square events. - Under Autentisering velger du HMAC.
- Under Signaturleverandør velger du Square. Appen fyller ut overskriften, algoritmen, den signerte nyttelasten og replay-vinduet for deg - det er ikke noe annet du trenger å konfigurere.
- La «secret»-feltet stå tomt foreløpig, og klikk på Lagre. Kopier webhook-URL-en som vises på siden.
Se Autentisering for de andre autentiseringsmodusene, og Kartlegging av nyttelast og Shopify Flow-variabler for å velge hvilke felt som skal sendes til Shopify Flow.
Trinn 2 - Legg til endepunktet i Square
I Square Developer Dashboard åpner du seksjonen Webhooks for applikasjonen din, legger til et abonnement med URL-adressen du kopierte, og kopierer signaturnøkkelen.
Slik finner du din Square-signeringsnøkkel
Signaturnøkkelen til webhook-abonnementet (Square Developer Dashboard → Webhooks).
Squares egen dokumentasjon om webhook-signaturer inneholder den nøyaktige ordlyden og skjermbilder for din konto.
Lim inn denne nøkkelen i feltet Secret for webhooken i Workflow Webhooks, og lagre. Fra og med da blir hver Square-leveranse verifisert før den når Shopify Flow.
Hva dette kontrollerer
| Hva | Verdi |
|---|---|
| Signaturhode | x-square-hmacsha256-signature |
| Hvor signaturen skal plasseres | Hele verdien i overskriften |
| Hva er det som er undertegnet? | {url}{body} |
| Signatur | HMAC-SHA256, base64-kodet |
| Tidsstempel | Brukes ikke av denne avsenderen |
| Beskyttelse mot avspilling | Ingen - denne avsenderen signerer ikke tidsstemplet, så alle gyldige signaturer forblir gyldige |
| Hemmeligheten | Brukes som ren tekst. Lim den inn nøyaktig slik avsenderen viser den |
I den signerte nyttelasten er {body} selve forespørselsinnholdet, byte for byte, og {url} er URL-en til denne webhooken.
En forespørsel som ikke oppfyller et av disse kravene, avvises med feilkoden 401, registreres i Historikk og feilsøking og setter aldri i gang en arbeidsflyt.
Trinn 3 - Opprett arbeidsflyten i Shopify Flow
- I Shopify Flow oppretter du en arbeidsflyt og velger utløseren Workflow Webhooks.
- Trykk på Registrer hendelser, og send deretter en testhendelse fra Square (eller bruk Send test i Workflow Webhooks), slik at Shopify Flow lærer seg hvordan dataene dine ser ut.
- Hver webhook du eier utløser den samme Shopify Flow-utløseren, så legg til et første vilkår basert på webhook-ID-en for å sikre at denne arbeidsflyten kun gjelder Square. ID-en vises på webhook-siden.
- Legg til handlinger - merk en kunde, legg til en merknad, send en intern e-post, oppdater et metafelt.
Trinn 4 - Test det fra start til slutt
Utløs en reell hendelse i Square. Under Workflow Webhooks → History bør du se utløsningen med statusen Success. Hvis signaturen var feil, får du i stedet en feilmelding med årsaken, og Verifisering av signerte webhooks forklarer signaturtesteren som viser deg nøyaktig hvilket trinn som mislyktes.
Signaturen stemmer ikke overens
I denne rekkefølgen: hemmeligheten (den vanligste årsaken - et ekstra mellomrom eller en nøkkel fra feil miljø), om avsenderen bruker hemmeligheten til et annet endepunkt, og om noe mellom Square og appen omskriver brødteksten. Signaturene dekker de rå byteene, så en proxy som omformaterer JSON ødelegger dem. Signaturtesteren på webhook-siden viser den eksakte teksten som ble signert.
Jeg får feilmelding 401 ved hver forespørsel
Kontroller at autentiseringen for webhooken er satt til HMAC med Square valgt som leverandør, at den hemmelige nøkkelen er fylt ut, og at Square sender data til URL-adressen nøyaktig slik den vises i appen, inkludert koden på slutten.
Det vises ingenting i historikken
Forespørselen kom aldri frem. Sjekk URL-adressen på nytt i Square, og se i Squares egen leveringslogg for å finne ut hvilket svar systemet mottok. En 404-feil betyr at webhooken er feil eller slettet, mens en 429-feil betyr at du har overskredet antall utløsninger i abonnementet ditt - se Planer og bruk.
Arbeidsflyten kjører for feil hendelser
Hver webhook i nettbutikken din utløser den samme Shopify Flow-utløseren. Legg til et vilkår basert på webhook-ID-en som det første trinnet i arbeidsflyten, eller begrens hvilke hendelser du sender fra Square.
Relatert
- Verifisering av signerte webhooks - alle leverandører vi verifiserer, og hvordan man beskriver en vi ikke verifiserer.
- Kartlegging av nyttelast og Shopify Flow-variabler - hente de riktige feltene fra payloaden og overføre dem til Shopify Flow.
- Beskyttelse mot dobbeltlevering - hva som skjer når Square prøver på en levering på nytt.
- Historikk og feilsøking - loggen over alle forespørsler, med mulighet for gjengivelse.