什麼是應用程式登錄
說明 ReceiptRoller 的應用程式登錄的概念。透過將應用程式登錄為 OAuth 用戶端,會發行用戶端 ID、密鑰、重新導向 URI,可開始 API、Webhook 串接。
商店應用程式 內容 API(公告、頁面、營業資訊)的使用方式
說明用於取得商店應用程式內容(公告、頁面、應用程式資訊清單、營業資訊、會員卡設定)的 /api/v1/apps/{shopId}/* 使用方式。解說 shopId 與商業帳戶 ID 相同、商業帳戶層級內容與店鋪層級內容的差異,以及驗證的處理方式。
店鋪向:以自家應用程式發行數位收據、以 Webhook 通知的指南
解說店鋪、品牌以自家應用程式向顧客發行數位收據,到以 Webhook 接收即時通知為止的步驟。涵蓋應用程式登錄、OAuth、Webhook 設定、簽章驗證。
新增建立應用程式
說明在 ReceiptRoller 的開發者入口登錄新的應用程式(OAuth 用戶端)的具體步驟。涵蓋輸入項目、驗證、建立後的憑證顯示、常見錯誤。
原生行動應用程式指南:多商業帳戶存取與 OAuth 流程
Android / iOS 原生應用程式的實作指南。應用程式登錄時將「授權時將權杖關聯至 1 個商業帳戶」關閉,即會發行 user-scoped OAuth 權杖。以 /api/v1/me/organizations + ?organizationId= 模式即可跨多個商業帳戶存取。
取得商業帳戶、店鋪、POS 端末的一覽
彙整從行動應用程式/伺服器應用程式以 REST API 一覽使用者所屬商業帳戶、其底下的店鋪、各店鋪 POS 端末的步驟。
利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。
店鋪資訊 API(Store Information API)的使用方式
說明如何以 REST API 取得、更新店鋪的基本資訊(店鋪名稱、店鋪類別、聯絡方式、地址)。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
利用開始為止的流程
說明 ReceiptRoller 的開發者入口利用開始為止的流程。作為店鋪使用者登錄,只要是 Starter 方案以上,無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。
店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
銷售管理 API(Orders / OMS API)的使用方式
這是使用 ReceiptRoller 銷售管理 API(/api/v1/orders)對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移(確認、處理中、取消)、刪除,以及適用於 Android/iOS 應用程式或伺服器串接的流程。
營業額實績 API(Sales API)的使用方式
彙整 ReceiptRoller 營業額實績 API(/api/v1/sales/*)的概要,以及依商業帳戶、店鋪、POS 端末、期間的篩選方法。這是一份涵蓋實際回應結構(KpiValue 巢狀型)與 averageTicket、權杖有效期限(8 小時)在內,為在 Android/iOS 行動應用程式或伺服器串接實作營業額儀表板的入門指南。
重新導向 URL 的設定
解說在 ReceiptRoller 的開發者入口設定的重新導向 URI(回呼 URL)的角色、登錄規則、開發與正式環境的分別使用、常見錯誤與因應方法。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
開發者向幫助目次
ReceiptRoller 開發者向幫助目次。彙整了開發者申請、應用程式登錄、OAuth 驗證與權限範圍、實作指南(錢包應用程式、店鋪向 Webhook、Survey API)、依資料領域別指南、運用與安全性、社群、疑難排解。
交易一覽 API(Transactions API:POS+OMS 整合摘要)的使用方式
ReceiptRoller 的 Transactions API 是將收銀營業額(PosTransactions)與銷售管理訂單(OmsOrders)整合為單一摘要的唯讀 API。在 Android/iOS 應用程式中一覽顯示「整個商業帳戶的交易」時,即為入口。