交易一覽 API(Transactions API:POS+OMS 整合摘要)的使用方式
ReceiptRoller 的 Transactions API 是將收銀營業額(PosTransactions)與銷售管理訂單(OmsOrders)整合為單一摘要的唯讀 API。在 Android/iOS 應用程式中一覽顯示「整個商業帳戶的交易」時,即為入口。
無法取得權杖(驗證錯誤)
無法取得存取權杖時的原因釐清。解說 invalid_client、invalid_grant、redirect_uri_mismatch 等代表性錯誤與因應。
密鑰的輪替與安全的保管
解說為安全運用 ReceiptRoller 的用戶端密鑰、Webhook 密鑰的輪替計畫、新舊並行期間的使用方式、保管的最佳實務。
SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
Webhook 的概要
解說 ReceiptRoller 的 Webhook 所投放的主要事件種類、應該使用 Webhook 而非輪詢的理由、投放形式(HTTPS POST + JSON)、投放保證的思考方式。
店鋪資訊 API(Store Information API)的使用方式
說明如何以 REST API 取得、更新店鋪的基本資訊(店鋪名稱、店鋪類別、聯絡方式、地址)。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
庫存管理 API(Inventory / WMS API)的使用方式
ReceiptRoller 庫存管理 API(Inventory / WMS API)的實作指南。解說以據點(倉庫、店鋪後場、賣場)為單位的庫存查詢、調整、異動紀錄取得方法,必要的 OAuth 權限範圍,Shopify 串接時的自動反映,以及從 MCP 工具(wms_get_stock / wms_adjust_stock 等)的使用方式。
監視與失敗時的對應
解說 ReceiptRoller Webhook 的投放紀錄的檢視方式、應監視的指標與警報設計、無效信件的重新投放、常見故障模式與復原步驟。
利用開始為止的流程
說明 ReceiptRoller 的開發者入口利用開始為止的流程。作為店鋪使用者登錄,只要是 Starter 方案以上,無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
重送、順序、冪等性的設計
解說 ReceiptRoller Webhook 的重送政策、投放順序不保證的理由、使用 event_id 的冪等性實作、無效信件的處理、常見反模式。
簽章驗證與安全性
解說 ReceiptRoller Webhook 的 HMAC-SHA256 簽章驗證的機制、驗證程式碼的範例(Node.js / Python / C#)、重放攻擊對策、密鑰的安全管理方法。
營業額實績 API(Sales API)的使用方式
彙整 ReceiptRoller 營業額實績 API(/api/v1/sales/*)的概要,以及依商業帳戶、店鋪、POS 端末、期間的篩選方法。這是一份涵蓋實際回應結構(KpiValue 巢狀型)與 averageTicket、權杖有效期限(8 小時)在內,為在 Android/iOS 行動應用程式或伺服器串接實作營業額儀表板的入門指南。
開發者入口可做的事
概觀 ReceiptRoller 的開發者入口可做的事。組合 REST API 的資料取得、操作與 Webhook 的即時事件接收,可從外部系統串接店鋪、使用者資料。
商品主檔(PIM)、類別資料
解說 ReceiptRoller 的商品主檔(PIM)、類別、變體的資料結構、CRUD 操作、SKU 管理、與 EC 的同步模式。
新增建立應用程式
說明在 ReceiptRoller 的開發者入口登錄新的應用程式(OAuth 用戶端)的具體步驟。涵蓋輸入項目、驗證、建立後的憑證顯示、常見錯誤。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。