快應(yīng)用 賬號(hào)

2020-08-08 15:41 更新

接口聲明

{"name": "service.account"}

導(dǎo)入模塊

import account from '@service.account' 
或 
const account = require('@service.account')

接口定義

account.getProvider()

獲取服務(wù)提供商。

參數(shù):

無(wú)

返回值:

字符串,服務(wù)提供商的代號(hào),如廠(chǎng)商的英文品牌名稱(chēng),假如無(wú)此服務(wù)則返回空字符串

示例:

console.log(account.getProvider())

account.authorize(OBJECT)

進(jìn)行OAuth授權(quán)。

參數(shù):

參數(shù)名 類(lèi)型 必填 說(shuō)明
type String 授權(quán)碼模式為code,簡(jiǎn)化模式為token。
redirectUri Uri 重定向URI。
scope String 申請(qǐng)的權(quán)限范圍,目前只支持一種scope,假如不填則getProfile只返回openId。 scope.baseProfile:獲取用戶(hù)基本信息。
state String 可以指定任意值,認(rèn)證服務(wù)器會(huì)原封不動(dòng)地返回這個(gè)值。
success Function 成功回調(diào)
fail Function 失敗回調(diào)
complete Function 執(zhí)行結(jié)束后的回調(diào)
success返回值:
參數(shù)名 類(lèi)型 說(shuō)明
state String 請(qǐng)求時(shí)同字段指定的任意值。
code String 授權(quán)碼模式下可用,返回的授權(quán)碼。
accessToken String 簡(jiǎn)化模式下可用,返回的訪(fǎng)問(wèn)令牌。
tokenType String 簡(jiǎn)化模式下可用,訪(fǎng)問(wèn)令牌類(lèi)型。
expiresIn Number 簡(jiǎn)化模式下可用,訪(fǎng)問(wèn)令牌過(guò)期時(shí)間,單位為秒,如果通過(guò)其他方式設(shè)置,則此處可能為空。
scope String 簡(jiǎn)化模式下可用,實(shí)際權(quán)限范圍,如果與申請(qǐng)一致,則此處可能為空。
fail返回錯(cuò)誤代碼
錯(cuò)誤碼 說(shuō)明
201 用戶(hù)拒絕,獲取帳號(hào)權(quán)限失敗

示例:

account.authorize({
  type: 'code',
  redirectUri: 'http://www.example.com/',
  success: function (data) {
    console.log(`handling success: ${data.code}`)
  },
  fail: function (data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

接口定義

account.getProvider()

獲取服務(wù)提供商。

參數(shù):

無(wú)

返回值:

字符串,服務(wù)提供商的代號(hào),如廠(chǎng)商的英文品牌名稱(chēng),假如無(wú)此服務(wù)則返回空字符串

示例:

console.log(account.getProvider())

接口定義

account.isLogin(OBJECT) 

判斷賬戶(hù)登錄狀態(tài)。

參數(shù):

參數(shù)名 類(lèi)型 必填 說(shuō)明
success Function 成功回調(diào)
fail Function 失敗回調(diào)
complete Function 執(zhí)行結(jié)束后的回調(diào)
success 返回值:
參數(shù)名 類(lèi)型 說(shuō)明
isLogin Boolean 登錄狀態(tài)值。true表示已登錄,false表示未登錄
fail 返回錯(cuò)誤代碼:
錯(cuò)誤碼 說(shuō)明
200 通用錯(cuò)誤,判斷出錯(cuò)時(shí)返回該錯(cuò)誤碼

示例:

account.isLogin({
  success: function (data) {
    console.log('data.isLogin=' + data.isLogin)
    console.log('handling success' + JSON.stringify(data))
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
});

account.authorize(OBJECT)

進(jìn)行 OAuth 授權(quán)。

參數(shù):

參數(shù)名 類(lèi)型 必填 說(shuō)明
type String 授權(quán)碼模式為 code,簡(jiǎn)化模式為 token。
redirectUri Uri 重定向 URI。
scope String 申請(qǐng)的權(quán)限范圍,目前只支持一種 scope,假如不填則 getProfile 只返回 openId。 scope.baseProfile:獲取用戶(hù)基本信息。
state String 可以指定任意值,認(rèn)證服務(wù)器會(huì)原封不動(dòng)地返回這個(gè)值。
success Function 成功回調(diào)
fail Function 失敗回調(diào)
complete Function 執(zhí)行結(jié)束后的回調(diào)
success 返回值:
參數(shù)名 類(lèi)型 說(shuō)明
state String 請(qǐng)求時(shí)同字段指定的任意值。
code String 授權(quán)碼模式下可用,返回的授權(quán)碼。
accessToken String 簡(jiǎn)化模式下可用,返回的訪(fǎng)問(wèn)令牌。
tokenType String 簡(jiǎn)化模式下可用,訪(fǎng)問(wèn)令牌類(lèi)型。
expiresIn Number 簡(jiǎn)化模式下可用,訪(fǎng)問(wèn)令牌過(guò)期時(shí)間,單位為秒,如果通過(guò)其他方式設(shè)置,則此處可能為空。
scope String 簡(jiǎn)化模式下可用,實(shí)際權(quán)限范圍,如果與申請(qǐng)一致,則此處可能為空。
fail 返回錯(cuò)誤代碼
錯(cuò)誤碼 說(shuō)明
201 用戶(hù)拒絕,獲取帳號(hào)權(quán)限失敗

示例:

account.authorize({
  type: 'code',
  redirectUri: 'http://www.example.com/',
  success: function(data) {
    console.log(`handling success: ${data.code}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

account.getProfile(OBJECT)

獲得用戶(hù)基本信息。

參數(shù):

參數(shù)名 類(lèi)型 必填 說(shuō)明
token String 訪(fǎng)問(wèn)令牌
success Function 成功回調(diào)
fail Function 失敗回調(diào),返回失敗原因
complete Function 執(zhí)行結(jié)束后的回調(diào)
success 返回值:
參數(shù)名 類(lèi)型 說(shuō)明
openid String 用戶(hù)的 openid,可能為空
id String 用戶(hù)的 user id,可能為空
unionid String 用戶(hù)在開(kāi)放平臺(tái)上的唯一標(biāo)示符,本字段在滿(mǎn)足一定條件下才會(huì)返回(需要在廠(chǎng)商的開(kāi)放平臺(tái)上額外申請(qǐng))
nickname String 用戶(hù)的昵稱(chēng),可能為空
avatar Object 用戶(hù)的頭像圖片地址,可能為空,按照分辨率組織,當(dāng)只有一個(gè)分辨率時(shí),可以使用 default 對(duì)應(yīng)的圖片地址

unionid 機(jī)制說(shuō)明

如果開(kāi)發(fā)者擁有多個(gè)移動(dòng)應(yīng)用,可通過(guò) unionid 來(lái)區(qū)分用戶(hù)的唯一性,因?yàn)橹灰峭粋€(gè)開(kāi)放平臺(tái)帳號(hào)下的移動(dòng)應(yīng)用,用戶(hù)的 unionid 是唯一的。換句話(huà)說(shuō),同一用戶(hù),對(duì)同一個(gè)開(kāi)放平臺(tái)下的不同應(yīng)用,unionid 是相同的。

示例:

account.getProfile({
  token: 'abcdefg',
  success: function(data) {
    console.log(`handling success: ${data.nickname}`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

account.getPhoneNumber(OBJECT) 

使用該接口前需要先跟廠(chǎng)商簽訂相應(yīng)的商務(wù)合同,在獲取用戶(hù)的手機(jī)號(hào)碼時(shí),用戶(hù)同意后,默認(rèn)獲取當(dāng)前手機(jī)登錄的廠(chǎng)商賬號(hào)的手機(jī)號(hào)碼,或者通過(guò)驗(yàn)證的用戶(hù)輸入的其他手機(jī)號(hào)碼。

權(quán)限要求

每次請(qǐng)求時(shí)都需要用戶(hù)確認(rèn)

參數(shù):

參數(shù)名 類(lèi)型 必填 說(shuō)明
encrypt Boolean 獲取手機(jī)號(hào)碼是否加密,默認(rèn)false,加解密方案需要跟具體的廠(chǎng)商對(duì)接。
success Function 成功回調(diào)
fail Function 失敗回調(diào)
complete Function 執(zhí)行結(jié)束后的回調(diào)
success 返回值:
參數(shù)名 類(lèi)型 說(shuō)明
phoneNumber String 用戶(hù)手機(jī)號(hào)碼
fail 返回錯(cuò)誤代碼:
錯(cuò)誤碼 說(shuō)明
201 用戶(hù)拒絕,獲取用戶(hù)手機(jī)號(hào)碼失敗
203 還未實(shí)現(xiàn)這個(gè)接口
205 前一次請(qǐng)求尚未完成,不允許發(fā)起新的請(qǐng)求
1001 不允許調(diào)用這個(gè)接口,需要先跟廠(chǎng)商簽訂相關(guān)的商務(wù)合同

示例:

account.getPhoneNumber({
  encrypt: false,
  success: function(data) {
    console.log(`handling success phoneNumber${data.phoneNumber}`)
  },
  fail: function(data, code) {
    console.log(`handling fail!, code = ${code}`)
  }
})

后臺(tái)運(yùn)行限制

禁止使用。 后臺(tái)運(yùn)行詳細(xì)用法參見(jiàn) 后臺(tái)運(yùn)行腳本。

支持明細(xì)

廠(chǎng)商 支持 備注
小米 YES 小米帳號(hào)授權(quán)登錄服務(wù)
中興 1010+ -
華為 YES 華為開(kāi)發(fā)者聯(lián)盟
金立 1010+ 金立快應(yīng)用開(kāi)發(fā)者中心
聯(lián)想 no -
魅族 YES 魅族賬號(hào)接入服務(wù)
努比亞 1010+ 努比亞開(kāi)發(fā)者平臺(tái)
OPPO YES OPPO 開(kāi)放平臺(tái)
vivo YES vivo帳號(hào)授權(quán)登錄服務(wù)
一加 - -
預(yù)覽版 no 預(yù)覽版不提供賬號(hào)接口


以上內(nèi)容是否對(duì)您有幫助:
在線(xiàn)筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)