如何將 Square 連接到 Shopify Flow
Square 會針對其銷售點系統及線上產品中的付款、訂單、退款、客戶及庫存變動發送 webhook。Workflow Webhooks 會將該呼叫轉為 Shopify Flow 觸發器，讓您的商店能據此做出反應：為客戶加上標籤、新增訂單備註、發送內部電子郵件、更新元資料欄位 - - 凡是 Shopify Flow 能做的事，皆可實現。
本指南闡述了整個流程 - - Square 發送請求、Workflow Webhooks 接收並驗證、Shopify Flow 執行操作 - - 且每項請求都會驗證 Square 的 HMAC 簽名，因此唯有 Square 才能啟動您的工作流程。
您可以打造什麼
- 標記一位透過 Square 在您的實體店鋪消費的 Shopify 客戶。
- 當透過 Square 辦理退款時，請在客戶記錄中新增備註，以便客服人員掌握完整情況。
- 當 Square 系統中某個共用 SKU 的庫存量低於閾值時，請透過電子郵件通知相關人員。
常見的傳送事件包括：payment.created、refund.updated、customer.created、inventory.count.updated。
開始之前
- Workflow Webhooks 已安裝在您的 Shopify 商店中。
- Shopify Flow 已安裝，此應用程式可從 Shopify App Store 免費下載。
- 一個擁有建立 Webhook 權限的 Square 帳戶。
步驟 1 - 在 Workflow Webhooks 建立 Webhook
- 開啟 Workflow Webhooks → Webhooks → 建立 Webhook，並為其命名一個在 Shopify Flow 中您能認出的名稱，例如
Square events。 - 在「驗證」下，選擇 HMAC。
- 在「**簽名提供者」**下，選擇 Square。應用程式會自動為您填入標頭、演算法、已簽名有效載荷及重播視窗 - - 無需進行其他設定。
- 目前請將「密鑰」欄位留空，然後按下「儲存」。複製頁面上顯示的 Webhook URL。
有關其他驗證模式，請參閱 驗證；關於如何選擇哪些欄位會傳送至 Shopify Flow，請參閱 有效載荷映射與 Shopify Flow 變數。
步驟 2 - 在 Square 中新增終點
在 Square 開發者儀表板中，開啟您應用程式的「Webhooks」區段，使用您複製的 URL 新增一項訂閱，並複製「Signature」金鑰。
如何找出您的 Square 簽名密鑰
Webhook 訂閱的簽名金鑰（Square 開發者儀表板 → Webhooks）。
Square 官方關於 webhook 簽名的文件 提供了您帳戶的具體說明文字及螢幕截圖。
將該密鑰貼入 Workflow Webhooks 中的 webhook「**密鑰 (Secret)」**欄位，並儲存。從此之後，每筆 Square 交易在傳送至 Shopify Flow 之前，都會經過驗證。
此處檢查的內容
| 什麼 | 價值 |
|---|---|
| 簽名標題 | x-square-hmacsha256-signature |
| 簽名的位置 | 整個標頭值 |
| 簽署的內容為何 | {url}{body} |
| 簽名 | HMAC-SHA256，base64 編碼 |
| 時間戳記 | 此寄件者未使用此功能 |
| 重播保護 | 無 - 此寄件者未對時間戳記進行簽名，因此每個有效的簽名均保持有效 |
| 這個秘密 | 作為純文字使用。請完全依照發送者顯示的內容貼上 |
在已簽署的載荷中，{body} 代表原始請求正文（逐位元組），而 {url} 則是此 Webhook 的 URL。
若請求未能通過上述任一項檢查，系統將以「401」為由拒絕該請求，並將其記錄於 歷史與故障排除，且該請求絕不會啟動工作流程。
步驟 3 - 建立「Shopify Flow」工作流程
- 在 Shopify Flow 中，建立一個工作流程，並選擇「Workflow Webhooks」觸發器。
- 按下「記錄事件」，然後從 Square 發送一個測試事件（或使用 Workflow Webhooks 中的**「發送測試**」功能），讓 Shopify Flow 學習您資料的模式。
- 您擁有的每個 Webhook 都會觸發相同的「Shopify Flow」觸發器，因此請針對 Webhook ID 新增第一個條件，以確保此工作流程僅限於 Square。該 ID 會顯示在 Webhook 頁面中。
- 新增您的操作 - - 標記客戶、新增備註、發送內部電子郵件、更新元資料欄位。
步驟 4 - 進行端到端測試
在 Square 中觸發一個真實事件。在 Workflow Webhooks → 歷史紀錄 中，您應能看到狀態為**「成功」**的呼叫記錄。若簽名有誤，則會顯示狀態為「失敗」的記錄並附上原因；而 驗證已簽名的 Webhook 則說明了簽名測試工具，該工具會精確指出哪個步驟出現了錯誤。
簽名不符▾
依此順序：密鑰（最常見的原因 - - 多餘的空格，或來自錯誤環境的金鑰）、發送者是否使用了不同端點的密鑰，以及在 Square 與應用程式之間是否有任何環節重寫了請求內容。簽名涵蓋原始位元組，因此會重新格式化 JSON 的代理伺服器會破壞簽名。 Webhook 頁面上的簽名測試工具會顯示實際經過簽名的精確文字內容。
每次發送請求都會收到 401 錯誤▾
請確認 webhook 的驗證方式已設定為 HMAC 並選擇 Square 提供者，且已填入密鑰；同時請確認 Square 傳送至該 URL 的內容與應用程式顯示的完全一致，包括結尾處的代碼。
「歷史」中沒有任何記錄▾
該請求從未送達。請在 Square 中重新檢查 URL，並查看 Square 自身的傳送日誌，確認其收到的回應。若出現 404，表示 webhook 錯誤或已被刪除；若出現 429，則表示您已超過方案的呼叫次數限制 - - 請參閱 方案與使用方式。
工作流程針對錯誤的事件執行▾
您商店中的每個 Webhook 都會觸發相同的「Shopify Flow」觸發器。請在工作流程的第一步中，針對 Webhook ID 新增一個條件，或縮小您從 Square 傳送的事件範圍。
相關
- 驗證已簽名的 Webhook - 我們所核實的每家服務供應商，以及如何描述未經核實的服務供應商。
- 有效載荷映射與 Shopify Flow 變數 - 從載荷中擷取正確的欄位，並將其存入
Shopify Flow中。 - 重複送達防護 - 當 Square 重新嘗試送達時，會發生什麼情況？
- 歷史與故障排除 - 每個請求的日誌，並附有重播功能。