Come collegare Sanity a Shopify Flow
Sanity invia un Webhook basato su GROQ ogni volta che viene creato, aggiornato o eliminato un contenuto corrispondente alla Sua query. Workflow Webhooks trasforma tale chiamata in un Trigger di Shopify Flow, in modo che il Suo negozio possa reagire di conseguenza: assegnare un Tag a un cliente, aggiungere una nota all’ordine, inviare un’e-mail interna, aggiornare un Metacampo - qualsiasi cosa possa fare Shopify Flow.
La presente guida illustra l’intero percorso - Sanity invia, Workflow Webhooks riceve e verifica, Shopify Flow agisce - con la firma HMAC di Sanity verificata ad ogni richiesta, in modo che solo Sanity possa avviare il Suo workflow.
Cosa potete realizzare
- Aggiornare un metacampo Shopify quando la voce corrispondente nel CMS viene modificata, in modo che la vetrina online rimanga sincronizzata.
- Inviate un’e-mail al vostro team di merchandising quando viene pubblicata una landing page.
- Avviare un workflow di aggiornamento della cache dopo la pubblicazione dei contenuti.
Eventi tipici da inviare: pubblicazione di un documento, aggiornamento di un documento, eliminazione di un documento.
Prima di iniziare
- Workflow Webhooks installato sul Suo negozio Shopify.
- Shopify Flow installata, disponibile gratuitamente dall’App Store all’indirizzo Shopify.
- Un account su Sanity con l'autorizzazione a creare webhook.
Fase 1 - Creare il webhook all'indirizzo Workflow Webhooks
- Acceda a Workflow Webhooks -> Webhook -> Crea webhook e assegni al webhook un nome che potrà riconoscere in Shopify Flow, ad esempio
Sanity events. - Nella sezione "Autenticazione", selezioni HMAC.
- Nella sezione “Fornitore di firma”, selezionate Sanity. L’app inserirà automaticamente l’intestazione, l’algoritmo, il payload firmato e la finestra di replay; non è necessario configurare altro.
- Per il momento lasci il campo "Segreto" vuoto e clicchi su "Salva". Copi l'URL del webhook visualizzato nella pagina.
Per ulteriori informazioni sulle altre modalità di autenticazione, consulti il sito Autenticazione; per scegliere quali campi inviare a Shopify Flow, consulti il sito Mappatura del payload e variabili di flusso.
Fase 2 - Aggiungere l'endpoint in Sanity
In Sanity, acceda a API -> Webhook, crei un webhook basato su GROQ utilizzando l'URL che ha copiato e imposti il codice segreto.
Come individuare il proprio segreto di firma Sanity
L'impostazione "Secret" sul webhook basato su GROQ.
La documentazione ufficiale di Sanity sulle firme dei webhook, disponibile all'indirizzo, riporta il testo esatto e gli screenshot relativi al Suo account.
Inserisca tale segreto nel campo “Secret” del webhook all’indirizzo Workflow Webhooks e salvi. Da quel momento in poi, ogni invio da Sanity verrà verificato prima di raggiungere Shopify Flow.
Cosa verifica questa operazione
| Cosa | Valore |
|---|---|
| Intestazione della firma | sanity-webhook-signature |
| Dove si trova la firma | Nel valore v1 di tale intestazione, che contiene le coppie key=value separate da virgole |
| Cosa è stato firmato | {timestamp}.{body} |
| Firma | HMAC-SHA256, codificato in base64url |
| Data e ora | Il valore t dell’intestazione della firma, espresso in millisecondi Unix |
| Protezione contro la riproduzione | Nessuna - questo mittente non appone una firma sul timestamp, pertanto ogni firma valida rimane valida |
| Il segreto | Da utilizzare come testo semplice. Lo incolli esattamente come lo presenta il mittente |
Nel payload firmato, {body} rappresenta il corpo della richiesta non elaborato, byte per byte, mentre {timestamp} corrisponde al timestamp sopra indicato.
Una richiesta che non soddisfi uno qualsiasi di questi requisiti viene respinta con l'errore 401, viene registrata in Cronologia e risoluzione dei problemi e non avvia mai un workflow.
Fase 3 - Creazione del workflow Shopify Flow
- In "Shopify Flow", crei un workflow e selezioni il trigger "Workflow Webhooks".
- Clicchi su “Registra eventi”, quindi invii un evento di prova da Sanity (oppure utilizzi l’opzione “Invia prova” in Workflow Webhooks) in modo che Shopify Flow apprenda la struttura dei Suoi dati.
- Ogni webhook di cui disponete attiva lo stesso trigger del Shopify Flow; pertanto, aggiungete una prima condizione relativa all’ID del webhook per limitare questo workflow esclusivamente a Sanity. L’ID è riportato nella pagina dedicata ai webhook.
- Aggiunga le Sue azioni: contrassegni un cliente, aggiunga una nota, invii un’e-mail interna, aggiorni un metacampo.
Fase 4 - Eseguire un test end-to-end
Attivare un evento reale in Sanity. In Workflow Webhooks -> Cronologia dovrebbe comparire la richiesta con lo stato “Successo”. Se la firma non era corretta, verrà invece visualizzata una voce con lo stato “Fallito” e il motivo corrispondente; all’indirizzo Verifica dei webhook firmati è disponibile lo strumento di verifica della firma che indica esattamente quale fase non ha superato il controllo.
La firma non corrisponde▾
In questo ordine: il segreto (la causa più comune: uno spazio in eccesso o una chiave proveniente da un ambiente errato), se il mittente sta utilizzando il segreto di un endpoint diverso e se qualcosa tra Sanity e l’app riscrive il corpo del messaggio. Le firme coprono i byte grezzi, pertanto un proxy che riformatta il JSON le invalida. Il tester delle firme presente nella pagina del webhook mostra il testo esatto che è stato firmato.
Ricevo un errore 401 ad ogni richiesta▾
Si assicuri che l'autenticazione del webhook sia impostata su HMAC con il provider Sanity selezionato, che il codice segreto sia stato inserito e che Sanity effettui l'invio all'URL esattamente come indicato dall'app, compreso il codice alla fine.
Nella cronologia non compare nulla▾
La richiesta non è mai arrivata. Verifichi nuovamente l'URL in Sanity e controlli il registro di consegna di Sanity per verificare la risposta ricevuta. Un codice di errore 404 indica un webhook errato o eliminato, mentre un codice 429 indica che ha superato il limite di invocazioni previsto dal Suo piano; per ulteriori informazioni, consulti Piani e utilizzo.
Il workflow viene eseguito per eventi non corretti▾
Ogni webhook del Suo negozio attiva lo stesso trigger di Shopify Flow. Aggiunga una condizione relativa all**’ID** del webhook come primo passo del workflow, oppure restringa la selezione degli eventi che invia da Sanity.
Correlati
- Verifica dei webhook firmati - ogni fornitore che verifichiamo e come descrivere quelli che non verifichiamo.
- Mappatura del payload e variabili di flusso - estrarre i campi corretti dal payload e inserirli in Shopify Flow.
- Protezione contro le consegne duplicate - cosa accade quando Sanity effettua un nuovo tentativo di consegna.
- Cronologia e risoluzione dei problemi - il registro di ogni richiesta, con la possibilità di riprodurla.