SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
方案仍為免費而不顯示開發者入口網站
ReceiptRoller 的開發者入口網站不顯示時的確認步驟。解說方案為免費時的因應方法、商業帳戶切換、顯示反映時機。
交易一覽 API(Transactions API:POS+OMS 整合摘要)的使用方式
ReceiptRoller 的 Transactions API 是將收銀營業額(PosTransactions)與銷售管理訂單(OmsOrders)整合為單一摘要的唯讀 API。在 Android/iOS 應用程式中一覽顯示「整個商業帳戶的交易」時,即為入口。
代表性的 API 範例
以 curl 命令介紹 ReceiptRoller API 代表性端點的呼叫範例(收據取得、店鋪一覽、商品建立、Webhook 登錄)。
取得商業帳戶、店鋪、POS 端末的一覽
彙整從行動應用程式/伺服器應用程式以 REST API 一覽使用者所屬商業帳戶、其底下的店鋪、各店鋪 POS 端末的步驟。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。
用戶端 ID、用戶端密鑰的管理
解說 ReceiptRoller 應用程式登錄時發行的用戶端 ID、用戶端密鑰的取得方法、保管規則、外洩時的因應、多環境運用。
店鋪資訊 API(Store Information API)的使用方式
說明如何以 REST API 取得、更新店鋪的基本資訊(店鋪名稱、店鋪類別、聯絡方式、地址)。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
資料保護(匿名化、加密)的思維
解說 ReceiptRoller 串接應用程式的資料保護思維、加密(保管時、通信時)、匿名化、假名化的技巧,以及刪除政策。
營業額實績 API(Sales API)的使用方式
彙整 ReceiptRoller 營業額實績 API(/api/v1/sales/*)的概要,以及依商業帳戶、店鋪、POS 端末、期間的篩選方法。這是一份涵蓋實際回應結構(KpiValue 巢狀型)與 averageTicket、權杖有效期限(8 小時)在內,為在 Android/iOS 行動應用程式或伺服器串接實作營業額儀表板的入門指南。
密鑰的輪替與安全的保管
解說為安全運用 ReceiptRoller 的用戶端密鑰、Webhook 密鑰的輪替計畫、新舊並行期間的使用方式、保管的最佳實務。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。
回傳 403/401(權限、權限範圍)
API 呼叫回傳 401 或 403 時的原因釐清。解說權杖無效、權限範圍不足、無店鋪存取權、User 系審查未通過等典型情況。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。