利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
監視與失敗時的對應
解說 ReceiptRoller Webhook 的投放紀錄的檢視方式、應監視的指標與警報設計、無效信件的重新投放、常見故障模式與復原步驟。
用戶端 ID、用戶端密鑰的管理
解說 ReceiptRoller 應用程式登錄時發行的用戶端 ID、用戶端密鑰的取得方法、保管規則、外洩時的因應、多環境運用。
員工管理 API(Staff API)的使用方式
這是使用 ReceiptRoller 員工管理 API(/api/v1/staff)對商業帳戶底下的員工(Staff)進行 CRUD 操作的指南。支援與 Square Team Member 互通的欄位(假名、多工作分配、薪資結構)。
SLA、稼動率與故障時的確認步驟
解說 ReceiptRoller API 的稼動率目標、狀態頁面的確認方法、故障發生時的釐清步驟,以及支援升級的流程。
重送、順序、冪等性的設計
解說 ReceiptRoller Webhook 的重送政策、投放順序不保證的理由、使用 event_id 的冪等性實作、無效信件的處理、常見反模式。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
什麼是應用程式登錄
說明 ReceiptRoller 的應用程式登錄的概念。透過將應用程式登錄為 OAuth 用戶端,會發行用戶端 ID、密鑰、重新導向 URI,可開始 API、Webhook 串接。
利用開始為止的流程
說明 ReceiptRoller 的開發者入口利用開始為止的流程。作為店鋪使用者登錄,只要是 Starter 方案以上,無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
銷售管理 API(Orders / OMS API)的使用方式
這是使用 ReceiptRoller 銷售管理 API(/api/v1/orders)對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移(確認、處理中、取消)、刪除,以及適用於 Android/iOS 應用程式或伺服器串接的流程。
取得商業帳戶、店鋪、POS 端末的一覽
彙整從行動應用程式/伺服器應用程式以 REST API 一覽使用者所屬商業帳戶、其底下的店鋪、各店鋪 POS 端末的步驟。
原生行動應用程式指南:多商業帳戶存取與 OAuth 流程
Android / iOS 原生應用程式的實作指南。應用程式登錄時將「授權時將權杖關聯至 1 個商業帳戶」關閉,即會發行 user-scoped OAuth 權杖。以 /api/v1/me/organizations + ?organizationId= 模式即可跨多個商業帳戶存取。
SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
API 參考與文件的閱讀方式
說明 ReceiptRoller 的開發者向文件的構成與分別使用。開發者幫助、API 頂頁、Swagger 基底的 API 參考、開發者社群的 4 個入口,以及可用於 AI 助手或程式碼生成工具的 OpenAPI 規格(openapi/v1.json)的取得方法。
錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。
店鋪向:以自家應用程式發行數位收據、以 Webhook 通知的指南
解說店鋪、品牌以自家應用程式向顧客發行數位收據,到以 Webhook 接收即時通知為止的步驟。涵蓋應用程式登錄、OAuth、Webhook 設定、簽章驗證。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。