開放平台簡介
街口開放平台 (JOP)
在街口 App 內使用街口帳號登入 Web 的流程是以 OAuth 2.0 授權碼核發流程（Authorization Code Grant Flow）為基礎。開發者的應用必須能發出 server-side request，並接收來自街口伺服器端的資料。
街口開放平台提供各 ISV 業者訪問街口服務，ISV 業者使用街口開放平台前，需先取得 Credential (client_id) 以及對應的密鑰 (secret_key)。
Method 與 Scope
街口開放平台將以 scope 做為街口使用者授權 ISV 業者的權限控管，下面列表為各個 scope 對應使用的 API。
Method
| Method | Description |
|---|---|
| jkopay.system.oauth.token | 取得訪問令牌，以便後續呼叫 API |
| jkopay.user.profile | 取得街口用戶授權之資料 |
Scope
| Scope | API | Description |
|---|---|---|
| jkosAccount | jkopay.user.profile | 街口帳戶 |
| gender | jkopay.user.profile | 性別 |
| phone | jkopay.user.profile | 電話號碼 |
| jkopay.user.profile | ||
| birthday | jkopay.user.profile | 出生日期 |
| name | jkopay.user.profile | 姓名 |
| barcode | jkopay.user.profile | 手機載具條碼 |
操作流程
以下為 OAuth 驗證所需流程，於獲取 access_token 後，開發者的應用將可以透過該 access_token 訪問用戶授權在街口開放平台的操作。開發者的應用使用街口開放平台時，須遵守相關規定。下面範例將說明如何在街口用戶授權後獲取用戶於街口的個人資料。
- 取得 Auth Code (1~4)
- 開發者網頁通過街口提供 Library (.umd.js) 呼叫 JSAPI jkos.getAuthCode()，於需要取得授權的頁面啟動授權同意頁。API 規格請參考網頁文件：Web SDK 環境版本
- 換取 Access Token (6~7)
- 成功於第一步獲取 auth_code 後，開發者可以在自己的服務端透過 API jkopay.system.oauth.token 使用 auth_code 換取 access_token 。auth_code 作為換取 access_token 的憑證，每次使用者授權完成後，其返回參數中的 auth_code 將都不一樣， auth_code 只能使用一次，有效期為 24 小時，授權後的 24 小時內未被使用將自動過期。