可利用的資料領域
以一覽說明可從 ReceiptRoller 的開發者入口取得的資料領域。彙整交易、商品、庫存、訂單、顧客、優惠券、SNS、廣告、個人使用者資料等,各領域含的內容與取得方法、必要的權限範圍。
Survey API and receipt embed
ReceiptRoller 的問卷功能讓店鋪透過 QR/連結/數位收據嵌入收集回答,並可選擇性地回饋優惠券。本文涵蓋公開消費者 API、收據嵌入酬載,以及店鋪可附加至活動的觀眾鎖定規則。
開發者入口可做的事
概觀 ReceiptRoller 的開發者入口可做的事。組合 REST API 的資料取得、操作與 Webhook 的即時事件接收,可從外部系統串接店鋪、使用者資料。
店鋪向:以自家應用程式發行數位收據、以 Webhook 通知的指南
解說店鋪、品牌以自家應用程式向顧客發行數位收據,到以 Webhook 接收即時通知為止的步驟。涵蓋應用程式登錄、OAuth、Webhook 設定、簽章驗證。
Webhook 的概要
解說 ReceiptRoller 的 Webhook 所投放的主要事件種類、應該使用 Webhook 而非輪詢的理由、投放形式(HTTPS POST + JSON)、投放保證的思考方式。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
User 系權限範圍的審查申請
解說在 ReceiptRoller 處理一般消費者資料(user.* 權限範圍)的應用程式所需的審查申請流程、提交文件、審查基準、審查期間、常見退件理由。
預約管理 API(Reservations API)的使用方式
ReceiptRoller 預約管理 API(/api/v1/reservations)的指南。解說預約的 CRUD、狀態更新,預約框(時段)的取得、建立、整批產生,店鋪版面所登錄的座位(桌位、包廂、吧台)的取得,以及預約統計。
營業時間 API(Business Hours API)的使用方式
ReceiptRoller 營業時間 API(/api/v1/stores/{storeId}/business-hours)的指南。解說每個星期的營業時間的取得與更新、特別營業日(臨時歇業、營業時間變更)的登錄、店鋪的可營業時間(排班建立時的上限業務時間)的設定,以及目前是否營業中的判定。
CrmCustomerDto 參考
解說 ReceiptRoller 顧客主檔 CrmCustomerDto 的所有欄位。從 POS(Smaregi、Square)匯入的顧客資訊會正規化為此模型。
Webhook 的登錄方法
解說在 ReceiptRoller 的開發者入口登錄 Webhook 端點的步驟、訂閱事件的選法、測試投放、多端點的分開運用、刪除與暫停的方法。