Slik kobler du Sanity til Shopify Flow
Koble Sanity til Shopify Flow ved hjelp av HMAC-verifiserte webhooks. Trinnvis oppsett, utløsermerking, notater, e-poster eller oppdateringer av metafelt.
Sanity sender en GROQ-drevet webhook hver gang innhold som samsvarer med søket ditt opprettes, oppdateres eller slettes. Workflow Webhooks omdanner dette anropet til en Shopify Flow-utløser, slik at nettbutikken din kan reagere på det: merke en kunde, legge til en bestillingsmerknad, sende en intern e-post, oppdatere et metafelt - alt Shopify Flow kan gjøre.
Denne veiledningen beskriver hele prosessen - Sanity sender, Workflow Webhooks mottar og verifiserer, Shopify Flow utfører - og Sanitys HMAC-signatur kontrolleres ved hver forespørsel, slik at kun Sanity kan sette i gang arbeidsflyten din.
Hva du kan bygge
- Oppdater et Shopify-metafelt når den tilhørende CMS-oppføringen endres, slik at nettbutikken holder tritt.
- Send en e-post til markedsføringsteamet når en landingsside blir publisert.
- Start en prosess for oppvarming av hurtigbufferen etter en innholdsutgivelse.
Typiske hendelser som skal sendes: et dokument blir publisert, et dokument blir oppdatert, et dokument blir slettet.
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å Sanity 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
Sanity events. - Under Autentisering velger du HMAC.
- Under Signaturleverandør velger du Sanity. 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 Sanity
I Sanity åpner du API → Webhooks, oppretter en GROQ-drevet webhook med URL-adressen du kopierte, og angir hemmelig nøkkel.
Slik finner du din Sanity-signeringsnøkkel
Innstillingen «The Secret» på webhooken som drives av GROQ.
Sanitys 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 Sanity-levering verifisert før den når Shopify Flow.
Hva dette kontrollerer
| Hva | Verdi |
|---|---|
| Signaturhode | sanity-webhook-signature |
| Hvor signaturen skal plasseres | I v1-verdien til den overskriften, som inneholder key=value-par atskilt med kommaer |
| Hva er det som er undertegnet? | {timestamp}.{body} |
| Signatur | HMAC-SHA256, base64url-kodet |
| Tidsstempel | t-verdien i signaturhodet, angitt i Unix-millisekunder |
| 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 {timestamp} er tidsstempelet ovenfor.
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 Sanity (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 Sanity. 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 Sanity. 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 Sanity og appen omskriver brødteksten. Signaturene gjelder 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 Sanity valgt som leverandør, at den hemmelige nøkkelen er fylt ut, og at Sanity 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 Sanity, og se i Sanitys egen leveringslogg for å se hvilket svar den mottok. En 404-kode betyr at webhooken er feil eller slettet, mens en 429-kode 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 Sanity.
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 Sanity prøver på nytt å levere.
- Historikk og feilsøking - loggen over alle forespørsler, med mulighet for gjengivelse.