SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
開發者向幫助目次
ReceiptRoller 開發者向幫助目次。彙整了開發者申請、應用程式登錄、OAuth 驗證與權限範圍、實作指南(錢包應用程式、店鋪向 Webhook、Survey API)、依資料領域別指南、運用與安全性、社群、疑難排解。
監視與失敗時的對應
解說 ReceiptRoller Webhook 的投放紀錄的檢視方式、應監視的指標與警報設計、無效信件的重新投放、常見故障模式與復原步驟。
店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
Survey API and receipt embed
ReceiptRoller 的問卷功能讓店鋪透過 QR/連結/數位收據嵌入收集回答,並可選擇性地回饋優惠券。本文涵蓋公開消費者 API、收據嵌入酬載,以及店鋪可附加至活動的觀眾鎖定規則。
重新導向 URL 的設定
解說在 ReceiptRoller 的開發者入口設定的重新導向 URI(回呼 URL)的角色、登錄規則、開發與正式環境的分別使用、常見錯誤與因應方法。
商店應用程式 內容 API(公告、頁面、營業資訊)的使用方式
說明用於取得商店應用程式內容(公告、頁面、應用程式資訊清單、營業資訊、會員卡設定)的 /api/v1/apps/{shopId}/* 使用方式。解說 shopId 與商業帳戶 ID 相同、商業帳戶層級內容與店鋪層級內容的差異,以及驗證的處理方式。
SLA、稼動率與故障時的確認步驟
解說 ReceiptRoller API 的稼動率目標、狀態頁面的確認方法、故障發生時的釐清步驟,以及支援升級的流程。
交易一覽 API(Transactions API:POS+OMS 整合摘要)的使用方式
ReceiptRoller 的 Transactions API 是將收銀營業額(PosTransactions)與銷售管理訂單(OmsOrders)整合為單一摘要的唯讀 API。在 Android/iOS 應用程式中一覽顯示「整個商業帳戶的交易」時,即為入口。
Webhook 的概要
解說 ReceiptRoller 的 Webhook 所投放的主要事件種類、應該使用 Webhook 而非輪詢的理由、投放形式(HTTPS POST + JSON)、投放保證的思考方式。
原生行動應用程式指南:多商業帳戶存取與 OAuth 流程
Android / iOS 原生應用程式的實作指南。應用程式登錄時將「授權時將權杖關聯至 1 個商業帳戶」關閉,即會發行 user-scoped OAuth 權杖。以 /api/v1/me/organizations + ?organizationId= 模式即可跨多個商業帳戶存取。
銷售管理 API(Orders / OMS API)的使用方式
這是使用 ReceiptRoller 銷售管理 API(/api/v1/orders)對商業帳戶底下的訂單進行 CRUD 操作的指南。彙整訂單的建立、更新、狀態轉移(確認、處理中、取消)、刪除,以及適用於 Android/iOS 應用程式或伺服器串接的流程。
營業時間 API(Business Hours API)的使用方式
ReceiptRoller 營業時間 API(/api/v1/stores/{storeId}/business-hours)的指南。解說每個星期的營業時間的取得與更新、特別營業日(臨時歇業、營業時間變更)的登錄、店鋪的可營業時間(排班建立時的上限業務時間)的設定,以及目前是否營業中的判定。
預約管理 API(Reservations API)的使用方式
ReceiptRoller 預約管理 API(/api/v1/reservations)的指南。解說預約的 CRUD、狀態更新,預約框(時段)的取得、建立、整批產生,店鋪版面所登錄的座位(桌位、包廂、吧台)的取得,以及預約統計。
商品管理 API(Products API)的使用方式
這是使用 ReceiptRoller 商品管理 API(/api/v1/products)對商業帳戶底下的商品進行 CRUD 操作的指南。適用於在 Android/iOS 應用程式或伺服器串接讀寫 PIM(商品主檔)時的入門文章。
簽章驗證與安全性
解說 ReceiptRoller Webhook 的 HMAC-SHA256 簽章驗證的機制、驗證程式碼的範例(Node.js / Python / C#)、重放攻擊對策、密鑰的安全管理方法。