基礎開放能力 – 授權
getAuthCode
通過呼叫 jkos.getAuthCode 在需要取得使用者的授權資料時,喚起街口原生的授權頁面。
使用方法
jkos.getAuthCode(data, callback);
<button id="test">getAuthCode</button>
<script>
document.querySelector('#test').addEventListener('click', () => {
jkos.getAuthCode({
clientId : 'string' ,
scopes : ['phone', 'email', 'barcode'],
onSuccess: (authCode) => {},
onError: (e) => {
console.log(e.error)
console.log(e.errorMessage)
},
onRejectAuth: () => {}
}, (res) => {
console.log(res.error)
console.log(res.errorMessage)
})
})
</script>
入參說明
必須 第一個參數:data
參數 | 必填 | 型態 | 說明 |
---|---|---|---|
clientId | 是 | string | Client ID |
userId | 否 | string | 自有平台會員的使用者 ID(若 scopes 欄位有填寫 “binding” 時需必填) |
scopes | 是 | string | 需要提供的權限屬性,可使用 Array 指定多個 scope,像是 ['phone','email','barcode'] |
onSuccess | 是 | function | 取得 authCode 成功的回呼函式 |
onError | 否 | function | 取得 authCode 失敗的回呼函式 |
onRejectAuth | 否 | function | 當使用者拒絕授權時,點擊 < (返回)或 X (關閉),會呼叫的函式 |
如何使用自有平台會員 ID 綁定街口帳號?
啟用方式為:
- 開通 binding scopes (需與街口窗口申請)
- 呼叫 getAuthCode() 時
- scopes 填入
binding
- userId 填入
自有平台會員 ID
- scopes 填入
非必須 第二個參數: callback
返回設定函式成功與否,也可使用 async/await
取代 callback
參數 | 型態 | 說明 |
---|---|---|
error | number | 錯誤碼 – 詳情請參見錯誤代碼附錄 |
errorMessage | string | 此描述為相關錯誤的 ASCII 編碼可讀文字 |
錯誤碼回覆
請參閱 錯誤代碼附錄。