利用開始為止的流程
說明 ReceiptRoller 的開發者入口開始使用為止的流程。作為店鋪使用者登錄,只要是Starter 方案以上,無需另行的開發者申請。登錄應用程式就可以立刻開始 API 實作。
利用開始為止的流程
ReceiptRoller 的開發者入口,不是別域名的「開發者專用網站」,而是作為通常的店鋪管理畫面中的機能之一提供。因此,「作為開發者申請並等待核准」這樣的別流程原則沒有。作為店鋪使用者登錄並升級方案的話,從那時起開發者機能就能使用。
3 分鐘看整體樣貌
- 作為店鋪使用者登錄 — 與通常的店鋪帳戶建立相同
- 將方案升到 Starter 以上 — 免費方案不可利用開發者 API
- 在開發者入口登錄應用程式 — 發行用戶端 ID、密鑰
- 實作 OAuth 授權流程 — 指定必要的權限範圍取得權杖
- 以 API 或 Webhook 實作
只有處理個人使用者的收據、支出資料(user.* 權限範圍)的情況,追加需要事前審查。詳情請參閱本頁末尾與 OAuth 權限範圍一覽。
步驟 1:作為店鋪使用者登錄
建立 ReceiptRoller 的通常的店鋪帳戶。已作為店鋪使用者利用中的情況請跳過這個步驟。
- 從 ReceiptRoller 的頂頁選擇「免費開始」,輸入電子郵件地址、密碼、商業帳戶資訊
- 登錄 1 個以上的店鋪(因為 API 串接的對象範圍成為「商業帳戶」與「店鋪」)
- 登錄的時點是免費方案
店鋪帳戶建立的詳情請參閱店鋪帳戶的建立(店鋪向幫助)。
步驟 2:將方案升到 Starter 以上
開發者 API 在Starter 方案以上可利用。免費方案的狀態下,即使進到應用程式登錄畫面也無法建立。
- 開啟 商業帳戶選單 > 商業帳戶設定 > 方案、請款
- 從「升級」選擇 Starter 以上的方案,完成簽約手續
- 簽約完成同時開發者入口會被解放
各方案可用的機能請以方案與角色的關係確認。
步驟 3:在開發者入口登錄應用程式
從店鋪管理畫面的選單開啟開發者入口,登錄新的應用程式。
- 從店鋪管理畫面的選單開啟「開發者入口」或「Developer Portal」
- 點擊「登錄應用程式」或「新增建立應用程式」
- 輸入以下資訊:
- 應用程式名 — 授權畫面上向使用者顯示的名稱
- 重新導向 URI — OAuth 授權後回傳碼的目標 URL(可複數登錄)
- 必要的權限範圍 — 這個應用程式要求的 OAuth 權限範圍
- 登錄後會發行用戶端 ID 與用戶端密鑰
請務必複製並保管到安全的場所。遺失的情況需要重新產生(既有的密鑰會立即無效)。
步驟 4:設定 OAuth 權限範圍
指定應用程式需要的最小限度的權限範圍。權限範圍的完整一覽與取得限制請參閱 OAuth 權限範圍一覽與利用可否。
- 僅 Store 系權限範圍(
store.*/crm.*/sns.*/analytics.*) → 應用程式登錄同時可利用 - 含 User 系權限範圍(
user.*) → 應用程式的UserScopeStatus變成pending,營運團隊的審查後轉為approved
步驟 5:實作
使用取得的用戶端 ID、密鑰與重新導向 URI 實作 OAuth 授權流程,以存取權杖呼叫 API。想以 Webhook 接收事件的情況,接續登錄 Webhook URL。
請參閱依使用案例的實作指南。
使用 User 系權限範圍時的追加步驟
處理個人使用者的收據、支出、我的最愛店鋪等的資料的情況(user.* 權限範圍),除了上述的流程外還需要事前審查。
- 如通常登錄應用程式,指定
user.*權限範圍 - 登錄時點
UserScopeStatus = pending - 向 ReceiptRoller 的支援聯絡應用程式的使用案例、對象使用者、資料的處理方針
- 營運團隊的審查轉為
approved的話,在授權流程可使用user.*權限範圍
在未審查的狀態指定 user.* 呼叫授權 URL 會回傳 app_not_approved 錯誤。
常見問題
Q. 需要作為開發者建立別帳戶嗎?
A. 不需要。通常的店鋪帳戶就這樣可作為開發者帳戶使用。在商業帳戶內請將負責開發的成員作為員工招待,並賦與必要的角色。
Q. 測試、開發用與正式運用把應用程式分開比較好嗎?
A. 建議。因為應用程式可複數登錄,開發用與正式用把用戶端 ID 分開的話,可獨立管理重新導向 URI 或權限。
Q. 可以在免費方案試嗎?
A. 開發者 API 需要 Starter 方案以上。應用程式登錄畫面本身在免費方案不會顯示。想試的情況請從 Starter 的最小簽約試看看。
Q. 從既有的店鋪帳戶進到開發者入口的選單在哪?
A. 店鋪管理畫面的選單會顯示「開發者入口」或「Developer Portal」的項目。Starter 方案以上才會顯示。
Q. 自家 POS 串接等,只處理店鋪資料的情況也需要審查嗎?
A. 不需要。只要是 Store 系權限範圍,應用程式登錄同時可利用。需要審查的只有 user.* 權限範圍(消費者個人資料)。