新增建立應用程式
說明在 ReceiptRoller 的開發者入口登錄新的應用程式(OAuth 用戶端)的具體步驟。涵蓋輸入項目、驗證、建立後的憑證顯示、常見錯誤。
庫存管理 API(Inventory / WMS API)的使用方式
ReceiptRoller 庫存管理 API(Inventory / WMS API)的實作指南。解說以據點(倉庫、店鋪後場、賣場)為單位的庫存查詢、調整、異動紀錄取得方法,必要的 OAuth 權限範圍,Shopify 串接時的自動反映,以及從 MCP 工具(wms_get_stock / wms_adjust_stock 等)的使用方式。
StaffDto 參考
解說 ReceiptRoller 員工(Staff)主檔 StaffDto 的所有欄位。彙整與 POS(Square Team / Smaregi)的關聯、店鋪指派、雇用型態等結構。
開發者向幫助目次
ReceiptRoller 開發者向幫助目次。彙整了開發者申請、應用程式登錄、OAuth 驗證與權限範圍、實作指南(錢包應用程式、店鋪向 Webhook、Survey API)、依資料領域別指南、運用與安全性、社群、疑難排解。
SNS Webhook 旁路(LINE 等外部 SNS 的 Webhook 轉發)
解說 ReceiptRoller 將從 LINE 等 SNS 平台接收到的 Webhook,在店鋪端同意下轉發至開發者應用程式的「SNS Webhook 旁路」功能的機制、設定方法、簽章的處理、注意事項。
PosTransactionDto 規格 — 交易資料的欄位參考
解說 ReceiptRoller 處理的交易資料正規模型 PosTransactionDto 的所有欄位。依識別碼、日期時間、金額、明細、付款、員工、狀態、CRM 串接各類別,彙整欄位名稱、型別、意義,以及各 POS 供應商的填入方式,是給開發者與外部系統串接負責人的參考。Smaregi、Square 雙方的對應文章也會參照本文。
密鑰的輪替與安全的保管
解說為安全運用 ReceiptRoller 的用戶端密鑰、Webhook 密鑰的輪替計畫、新舊並行期間的使用方式、保管的最佳實務。
商品主檔(PIM)、類別資料
解說 ReceiptRoller 的商品主檔(PIM)、類別、變體的資料結構、CRUD 操作、SKU 管理、與 EC 的同步模式。
利用目的、串接對象(POS/EC/分析等)的申告
解說在 ReceiptRoller 的開發者入口登錄應用程式時申告的「利用目的」與「串接對象類別」(POS/EC/分析/CRM/OMS/WMS/SNS/其他)的意義、選法、變更時的注意、與 User 系權限範圍審查的關聯。
店鋪向:以自家應用程式發行數位收據、以 Webhook 通知的指南
解說店鋪、品牌以自家應用程式向顧客發行數位收據,到以 Webhook 接收即時通知為止的步驟。涵蓋應用程式登錄、OAuth、Webhook 設定、簽章驗證。
店內媒體顯示器 API(Display API)的使用方式
ReceiptRoller 店內 Android 顯示器 API(/api/v1/displays/*)的概要,以及配對、心跳、播放清單取得、播放實績回報的步驟彙整。這是為在 Android 電子看板或店內數位看板端末播放媒體循環而實作應用程式的入門指南。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
預約管理 API(Reservations API)的使用方式
ReceiptRoller 預約管理 API(/api/v1/reservations)的指南。解說預約的 CRUD、狀態更新,預約框(時段)的取得、建立、整批產生,店鋪版面所登錄的座位(桌位、包廂、吧台)的取得,以及預約統計。
User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
代表性的 API 範例
以 curl 命令介紹 ReceiptRoller API 代表性端點的呼叫範例(收據取得、店鋪一覽、商品建立、Webhook 登錄)。