Survey API and receipt embed
ReceiptRoller 的問卷功能讓店鋪透過 QR/連結/數位收據嵌入收集回答,並可選擇性地回饋優惠券。本文涵蓋公開消費者 API、收據嵌入酬載,以及店鋪可附加至活動的觀眾鎖定規則。
店鋪向:以自家應用程式發行數位收據、以 Webhook 通知的指南
解說店鋪、品牌以自家應用程式向顧客發行數位收據,到以 Webhook 接收即時通知為止的步驟。涵蓋應用程式登錄、OAuth、Webhook 設定、簽章驗證。
錢包應用程式向:以 OAuth 取得使用者的收據的指南
解說從 iOS、Android、LINE Mini App 等錢包型應用程式,在使用者同意下取得 ReceiptRoller 的購買收據的方法。涵蓋 OAuth 2.0 驗證、收據 API、Webhook 串接。
開發者入口可做的事
概觀 ReceiptRoller 的開發者入口可做的事。組合 REST API 的資料取得、操作與 Webhook 的即時事件接收,可從外部系統串接店鋪、使用者資料。
開發者向幫助目次
ReceiptRoller 開發者向幫助目次。彙整了開發者申請、應用程式登錄、OAuth 驗證與權限範圍、實作指南(錢包應用程式、店鋪向 Webhook、Survey API)、依資料領域別指南、運用與安全性、社群、疑難排解。
可利用的資料領域
以一覽說明可從 ReceiptRoller 的開發者入口取得的資料領域。彙整交易、商品、庫存、訂單、顧客、優惠券、SNS、廣告、個人使用者資料等,各領域含的內容與取得方法、必要的權限範圍。
商品主檔(PIM)、類別資料
解說 ReceiptRoller 的商品主檔(PIM)、類別、變體的資料結構、CRUD 操作、SKU 管理、與 EC 的同步模式。
資料保護(匿名化、加密)的思維
解說 ReceiptRoller 串接應用程式的資料保護思維、加密(保管時、通信時)、匿名化、假名化的技巧,以及刪除政策。
利用開始為止的流程
說明 ReceiptRoller 的開發者入口利用開始為止的流程。作為店鋪使用者登錄,只要是 Starter 方案以上,無需另行的開發者申請即可立刻開始應用程式登錄與 API 實作。
新增建立應用程式
說明在 ReceiptRoller 的開發者入口登錄新的應用程式(OAuth 用戶端)的具體步驟。涵蓋輸入項目、驗證、建立後的憑證顯示、常見錯誤。
CrmCustomerDto 參考
解說 ReceiptRoller 顧客主檔 CrmCustomerDto 的所有欄位。從 POS(Smaregi、Square)匯入的顧客資訊會正規化為此模型。
Webhook 的登錄方法
解說在 ReceiptRoller 的開發者入口登錄 Webhook 端點的步驟、訂閱事件的選法、測試投放、多端點的分開運用、刪除與暫停的方法。
OAuth 權限範圍一覽與利用可否
說明 ReceiptRoller 的 OAuth API 可利用的權限範圍的一覽,與各權限範圍被授予哪種類型的應用程式。也涵蓋 User 系權限範圍的審查要件、Store 系與 User 系無法混在的理由、從 LIFF 應用程式的利用方法。
PosTransactionDto 規格 — 交易資料的欄位參考
解說 ReceiptRoller 處理的交易資料正規模型 PosTransactionDto 的所有欄位。依識別碼、日期時間、金額、明細、付款、員工、狀態、CRM 串接各類別,彙整欄位名稱、型別、意義,以及各 POS 供應商的填入方式,是給開發者與外部系統串接負責人的參考。Smaregi、Square 雙方的對應文章也會參照本文。