Come collegare Square a Shopify Flow
Square invia un Webhook relativo a pagamenti, ordini, rimborsi, clienti e variazioni di inventario attraverso i propri prodotti per punti vendita e online. Workflow Webhooks trasforma tale richiesta 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 operazione che Shopify Flow sia in grado di eseguire.
La presente guida illustra l’intero processo - Square invia, Workflow Webhooks riceve e verifica, Shopify Flow agisce - con la firma HMAC di Square verificata ad ogni richiesta, in modo che solo Square possa avviare il Suo workflow.
Cosa potete realizzare
- Indichi un cliente di Shopify che ha effettuato un acquisto nel Suo negozio fisico tramite Square.
- Aggiunga una nota relativa al cliente ogni volta che viene emesso un rimborso tramite Square, in modo che l'assistenza possa avere un quadro completo della situazione.
- Inviare un’e-mail al personale quando l’inventario su Square relativo a uno SKU condiviso scende al di sotto di una soglia prestabilita.
Eventi tipici da inviare: payment.created, refund.updated, customer.created, inventory.count.updated.
Prima di iniziare
- Workflow Webhooks installato sul Suo negozio Shopify.
- Shopify Flow installata, disponibile gratuitamente dall’App Store all’indirizzo Shopify.
- Un account su Square con l'autorizzazione a creare webhook.
Fase 1 - Creare il webhook all'indirizzo Workflow Webhooks
- Acceda a Workflow Webhooks -> Webhook -> Crea webhook e assegni un nome che possa riconoscere in Shopify Flow, ad esempio
Square events. - Nella sezione "Autenticazione", selezioni HMAC.
- Alla voce “Fornitore di firma”, selezionate Square. L’app inserirà automaticamente l’intestazione, l’algoritmo, il payload firmato e la finestra di replay: non è necessario configurare nient’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, si prega di consultare Autenticazione; per informazioni su come scegliere quali campi inviare a Shopify Flow, si prega di consultare Mappatura del payload e variabili di flusso.
Fase 2 - Aggiungere l'endpoint in Square
Nella dashboard per sviluppatori di Square, apra la sezione “Webhook” della Sua applicazione, aggiunga un abbonamento con l’URL che ha copiato e copi la chiave di firma.
Come individuare il Suo codice segreto di firma Square
La chiave di firma dell'abbonamento al webhook (Pannello di controllo per sviluppatori Square -> Webhook).
La documentazione ufficiale di Square sulle firme dei webhook, disponibile all'indirizzo, riporta il testo esatto e le schermate relative al Suo account.
Inserisca tale codice segreto nel campo "Secret" del webhook all'indirizzo Workflow Webhooks e salvi. Da quel momento in poi, ogni transazione Square verrà verificata prima di raggiungere Shopify Flow.
Cosa verifica questa operazione
| Cosa | Valore |
|---|---|
| Intestazione della firma | x-square-hmacsha256-signature |
| Dove si trova la firma | Il valore completo dell'intestazione |
| Cosa è stato firmato | {url}{body} |
| Firma | HMAC-SHA256, codificato in base64 |
| Data e ora | Non utilizzato da questo mittente |
| 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 in formato grezzo, byte per byte, mentre {url} è l'URL di questo webhook.
Una richiesta che non soddisfi uno qualsiasi di questi requisiti viene respinta con il codice di 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 Square (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 di Shopify Flow; pertanto, aggiungete una prima condizione relativa all’ID del webhook per limitare questo workflow esclusivamente a Square. 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
Attivi un evento reale in Square. In Workflow Webhooks -> Cronologia dovrebbe visualizzare la richiesta con stato “Successo”. Se la firma non era corretta, verrà invece visualizzata una voce con 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 è andata a buon fine.
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 Square 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 di firme nella pagina del webhook mostra il testo esatto che è stato firmato.
Ricevo un errore 401 ad ogni richiesta▾
Si verifichi che l'autenticazione del webhook sia impostata su HMAC con il provider Square selezionato, che il codice segreto sia stato inserito e che Square invii i dati all'URL esattamente come indicato dall'app, compreso il codice alla fine.
Nella cronologia non compare nulla▾
La richiesta non è mai pervenuta. Verifichi nuovamente l’URL in Square e consulti il registro di consegna di Square per verificare la risposta ricevuta. Un codice di errore 404 indica un webhook errato o eliminato, mentre un codice 429 significa 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 inviati da Square.
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 succede quando Square effettua un nuovo tentativo di consegna.
- Cronologia e risoluzione dei problemi - il registro di ogni richiesta, con la possibilità di riprodurla.