User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
User 系權限範圍回傳 app_not_approved
使用 User 系權限範圍時回傳 app_not_approved 錯誤時的確認步驟。解說在沙箱框架下的開發、審查申請、沙箱轉正式環境的流程。
回傳 403/401(權限、權限範圍)
API 呼叫回傳 401 或 403 時的原因釐清。解說權杖無效、權限範圍不足、無店鋪存取權、User 系審查未通過等典型情況。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
原生行動應用程式指南:多商業帳戶存取與 OAuth 流程
Android / iOS 原生應用程式的實作指南。應用程式登錄時將「授權時將權杖關聯至 1 個商業帳戶」關閉,即會發行 user-scoped OAuth 權杖。以 /api/v1/me/organizations + ?organizationId= 模式即可跨多個商業帳戶存取。
開發者向幫助目次
ReceiptRoller 開發者向幫助目次。彙整了開發者申請、應用程式登錄、OAuth 驗證與權限範圍、實作指南(錢包應用程式、店鋪向 Webhook、Survey API)、依資料領域別指南、運用與安全性、社群、疑難排解。
利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。
新增建立應用程式
說明在 ReceiptRoller 的開發者入口登錄新的應用程式(OAuth 用戶端)的具體步驟。涵蓋輸入項目、驗證、建立後的憑證顯示、常見錯誤。
什麼是應用程式登錄
說明 ReceiptRoller 的應用程式登錄的概念。透過將應用程式登錄為 OAuth 用戶端,會發行用戶端 ID、密鑰、重新導向 URI,可開始 API、Webhook 串接。
重新導向 URL 的設定
解說在 ReceiptRoller 的開發者入口設定的重新導向 URI(回呼 URL)的角色、登錄規則、開發與正式環境的分別使用、常見錯誤與因應方法。
利用開始為止的流程
說明 ReceiptRoller 的開發者入口利用開始為止的流程。作為店鋪使用者登錄,只要是 Starter 方案以上,無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
代表性的 API 範例
以 curl 命令介紹 ReceiptRoller API 代表性端點的呼叫範例(收據取得、店鋪一覽、商品建立、Webhook 登錄)。
預約管理 API(Reservations API)的使用方式
ReceiptRoller 預約管理 API(/api/v1/reservations)的指南。解說預約的 CRUD、狀態更新,預約框(時段)的取得、建立、整批產生,店鋪版面所登錄的座位(桌位、包廂、吧台)的取得,以及預約統計。
店鋪資訊 API(Store Information API)的使用方式
說明如何以 REST API 取得、更新店鋪的基本資訊(店鋪名稱、店鋪類別、聯絡方式、地址)。可從員工應用程式等以權杖驗證的用戶端實作店鋪資訊的編輯畫面。
開發者入口可做的事
概觀 ReceiptRoller 的開發者入口可做的事。組合 REST API 的資料取得、操作與 Webhook 的即時事件接收,可從外部系統串接店鋪、使用者資料。
營業時間 API(Business Hours API)的使用方式
ReceiptRoller 營業時間 API(/api/v1/stores/{storeId}/business-hours)的指南。解說每個星期的營業時間的取得與更新、特別營業日(臨時歇業、營業時間變更)的登錄、店鋪的可營業時間(排班建立時的上限業務時間)的設定,以及目前是否營業中的判定。
店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。