店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。
監視與失敗時的對應
解說 ReceiptRoller Webhook 的投放紀錄的檢視方式、應監視的指標與警報設計、無效信件的重新投放、常見故障模式與復原步驟。
簽章驗證與安全性
解說 ReceiptRoller Webhook 的 HMAC-SHA256 簽章驗證的機制、驗證程式碼的範例(Node.js / Python / C#)、重放攻擊對策、密鑰的安全管理方法。
銷售管理 API(Orders / OMS API)的使用方式
這是使用 ReceiptRoller 銷售管理 API(/api/v1/orders)對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移(確認、處理中、取消)、刪除,以及適用於 Android/iOS 應用程式或伺服器串接的流程。
User 系權限範圍回傳 app_not_approved
使用 User 系權限範圍時回傳 app_not_approved 錯誤時的確認步驟。解說在沙箱框架下的開發、審查申請、沙箱轉正式環境的流程。
用戶端 ID、用戶端密鑰的管理
解說 ReceiptRoller 應用程式登錄時發行的用戶端 ID、用戶端密鑰的取得方法、保管規則、外洩時的因應、多環境運用。
可利用的資料領域
以一覽說明可從 ReceiptRoller 的開發者入口取得的資料領域。彙整交易、商品、庫存、訂單、顧客、優惠券、SNS、廣告、個人使用者資料等,各領域含的內容與取得方法、必要的權限範圍。
重新導向 URL 的設定
解說在 ReceiptRoller 的開發者入口設定的重新導向 URI(回呼 URL)的角色、登錄規則、開發與正式環境的分別使用、常見錯誤與因應方法。
PosTransactionDto 規格 — 交易資料的欄位參考
解說 ReceiptRoller 處理的交易資料正規模型 PosTransactionDto 的所有欄位。依識別碼、日期時間、金額、明細、付款、員工、狀態、CRM 串接各類別,彙整欄位名稱、型別、意義,以及各 POS 供應商的填入方式,是給開發者與外部系統串接負責人的參考。Smaregi、Square 雙方的對應文章也會參照本文。
CrmCustomerDto 參考
解說 ReceiptRoller 顧客主檔 CrmCustomerDto 的所有欄位。從 POS(Smaregi、Square)匯入的顧客資訊會正規化為此模型。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。
User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
Webhook 的登錄方法
解說在 ReceiptRoller 的開發者入口登錄 Webhook 端點的步驟、訂閱事件的選法、測試投放、多端點的分開運用、刪除與暫停的方法。
錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。