新增建立應用程式

從 ReceiptRoller 的店鋪管理畫面開啟開發者入口，登錄新的應用程式（OAuth 用戶端）。所需時間約 3〜5 分鐘。

前提

• 持有 ReceiptRoller 的店鋪帳戶
• 商業帳戶的方案為Starter 方案以上
• 登入中的成員持有業主或開發者角色

不滿足的情況請先參閱利用開始為止的流程。

步驟 1：開啟開發者入口

1. 登入店鋪管理畫面
2. 從左選單選擇「開發者入口」或「Developer Portal」
3. 會顯示應用程式一覽畫面

選單中未顯示的情況，請確認方案是否仍為免費（利用開始為止的流程）。

步驟 2：點擊「登錄應用程式」

點擊應用程式一覽畫面右上的「登錄應用程式」或「新增建立應用程式」按鈕，登錄表單會開啟。

步驟 3：輸入必要項目

應用程式名的訣竅

• 具體地 — 比起「API 測試」，「自家 EC 串接 (正式)」較容易管理
• 含入環境 — 開發、正式登錄不同應用程式時，加上「(dev)」「(prod)」防止失誤
• 2〜30 字 — 授權畫面的版面不會崩壞的長度

重新導向 URI 的輸入

• HTTPS 必填（正式） — http:// 在 localhost 以外不接受
• 完全一致 — 授權 URL 指定的 redirect_uri，需要與這裡登錄的 URI 完全一致（含末尾的斜線、大小寫）
• 可複數登錄 — 例: http://localhost:3000/callback（開發）與 https://your-app.example.com/callback（正式）兩者都登錄
• 查詢、片段不可 — ?foo=bar 或 #hash 無法含入

詳情在下節重新導向 URL 的設定解說。

權限範圍的選擇

請以最小限度選擇必要的權限範圍。「為了以防萬一」追加不建議。追加、刪除權限範圍的情況，需要重新取得既有的存取權杖。

• 僅 Store 系（store.* / crm.* / sns.* / analytics.*） → 可即時利用
• 含 User 系（user.*） → 需要審查（參照 OAuth 權限範圍一覽）
• Store 系與 User 系不可混合 — 同一應用程式無法要求兩者。兩者處理的情況登錄 2 個應用程式

步驟 4：點擊「建立」按鈕

輸入完所有必填項目後點擊「建立」或「登錄」。有驗證錯誤的話會在該欄位以紅字顯示。

步驟 5：保管憑證

建立成功後，會顯示用戶端 ID 與用戶端密鑰。

用戶端 ID 即使公開也沒問題。在應用程式的設定畫面隨時可確認。

建立後可做的事

登錄的應用程式，可從開發者入口的應用程式一覽再次開啟進行以下操作。

• 應用程式名、說明、URL 的編輯 — 名稱變更或說明的更新隨時可能
• 重新導向 URI 的追加、刪除 — 因應環境追加柔軟地管理
• 權限範圍的變更 — 既有權杖需要重新取得
• 密鑰的重新產生 — 外洩時、定期輪替時。舊密鑰立即無效化
• 應用程式的無效化、刪除 — 利用結束時。既有的存取權杖也會無效
• 稽核日誌的確認 — 這個應用程式經由的主要 API 存取、權杖發行紀錄

常見錯誤

下一步

應用程式登錄完成後，請接續實作以下。

• 重新導向 URI 的整理 — 開發、正式的分別使用法在本章的重新導向 URL 設定
• OAuth 授權流程 — 使用用戶端 ID、密鑰的授權碼流程的實作在API 驗證指南
• 依使用案例的指南 — 店鋪向 Webhook 指南 / 錢包應用程式向指南

相關指南

• 什麼是應用程式登錄
• OAuth 權限範圍一覽與利用可否
• API 驗證指南（OAuth 2.0 授權碼流程）
• 返回開發者向幫助目次