一键登录@univerify

# 一键登录

univerify 是DCloud 推出的一键登录产品，通过与运营商深度合作，实现APP用户无需输入帐号密码，即可使用本机手机号码自动登录的能力。

univerify是替代短信验证登录的下一代登录验证方式，能消除现有短信验证模式等待时间长、操作繁琐和容易泄露的痛点。

注意：一键登录必须是手机使用流量的前提下才能获取到手机号码，用Wi-Fi联网时无法获取到手机号码，同时如果是双卡手机，获取到的手机号码是默认移动数据的那个手机卡的号码。

# 重要调整

# 云函数使用一键登录扩展库

自HBuilderX 3.4.0起，一键登录相关功能移至扩展库uni-cloud-verify内。在一段时间内无论开发者是否使用扩展库云函数都可以正常使用uniCloud.getPhoneNumber。HBuilderX 3.4.0及之后的版本上传云函数时如果没有指定使用uni-cloud-verify扩展库的云函数将无法调用uniCloud.getPhoneNumber接口。

关于扩展库的说明见：云函数扩展库

在云函数的package.json内添加uni-cloud-verify的引用即可为云函数启用此扩展，无需做其他调整，完整的package.json示例如下：

{
  "name": "univerify",
  "extensions": {
    "uni-cloud-verify": {} // 启用一键登录扩展，值为空对象即可
  }
}

# 客户端

客户端如何使用一键登录请参考此文档：univerify 使用指南

# 云函数

自HBuilderX 3.4.0起云函数需启用uni-cloud-verify扩展之后才可以调用getPhoneNumber接口，详细说明见：云函数使用一键登录扩展库

客户端调用一键登录接口会获取如下结果

{
    "target": {
        "id": "univerify",
        "description": "一键登录",
        "authResult": {
            "openid": "xxx",
            "access_token": "xxx"
        }
    }
}

使用上面结果中的openid和access_token即可在云函数内调用接口获取手机号

云函数内接口调用形式如下

exports.main = async function(event, context){
  const res = await uniCloud.getPhoneNumber({
    provider: 'univerify',
    appid: context.APPID, // 客户端callFunction时携带的AppId信息
    access_token: event.access_token,
    openid: event.openid
  })
  // res形式如下
  // {
  //   code: 0,
  //   message: '',
  //   phoneNumber: '138xxxxxxxx'
  // }
}

相关文档

注意

由于历史原因，如果未关联uni-cloud-verify扩展库也可能会在不填写apiKey时提示缺少apiKey，请主动为云函数关联uni-cloud-verify扩展库
如下插件需要升级后才不会检查apiKey、apiSecret必填，如果使用uni-id公共模块需要更新到3.3.31版本，如果使用uni-id-pages需要更新到1.1.17版本，如果使用了uni-starter需要更新到2.1.6版本

# uni-app项目

如果开发uni-app项目可以使用callFunction的方式调用云函数

// 客户端
uniCloud.callFunction({
  name: 'xxx', // 你的云函数名称
  data: {
    access_token: 'xxx', // 客户端一键登录接口返回的access_token
    openid: 'xxx' // 客户端一键登录接口返回的openid
  }
}).then(res => {
  // res.result = {
  //   code: '',
  //   message: ''
  // }
}).catch(err=>{
  // 处理错误
})

// 云函数
exports.main = async function (event, context){
  const res = await uniCloud.getPhoneNumber({
    appid: context.APPID, // 客户端callFunction时携带的AppId信息
    provider: 'univerify',
    access_token: event.access_token,
    openid: event.openid
  })
  // 执行入库等操作，正常情况下不要把完整手机号返回给前端
  return {
    code: 0,
    message: '获取手机号成功'
  }
}

注意

开发期间如果重新获取过appid需要重新编译uni-app项目

# 5+项目

5+项目不可使用callFunction请求云函数，这时候可以使用云函数URL化让5+项目通过http请求的方式访问云函数

// 客户端
const xhr = new plus.net.XMLHttpRequest();
xhr.onload = function(e) {
  const {
    code,
    message
  } = JSON.parse(xhr.responseText)
}
xhr.open( "POST", "https://xxx" ); // url应为云函数Url化之后的地址，可以在uniCloud web控制台云函数详情页面看到
xhr.setRequestHeader('Content-Type','application/json');
xhr.send(JSON.stringify({
  access_token: 'xxx', // 客户端一键登录接口返回的access_token
  openid: 'xxx' // 客户端一键登录接口返回的openid
}));

// 云函数，下面仅展示客户端使用post方式发送content-type为application/json请求的场景
exports.main = async function(event){
  let body = event.body
  if(event.isBase64Encoded) {
    body = Buffer.from(body,'base64')
  }
  const {
    access_token,
    openid
  } = JSON.parse(body)
  const res = await uniCloud.getPhoneNumber({
    provider: 'univerify',
    appid: 'xxx', // DCloud appid
    access_token: access_token,
    openid: openid
  })
  // 执行入库等操作，正常情况下不要把完整手机号返回给前端
  return {
    code: 0,
    message: '获取手机号成功'
  }
}

# 自有服务器调用

写法类似上面5+项目的云函数url化的方式，但是不同的是需要云函数返回手机号给自己服务器，这样就需要确保数据安全。

下面以一个简单的例子演示如何使用签名验证请求是否合法

// 以nodejs为例
const crypto = require('crypto')

const secret = 'your-secret-string' // 自己的密钥不要直接使用示例值，且注意不要泄露
const hmac = crypto.createHmac('sha256', secret);

// 自有服务器生成签名，并以GET方式发送请求
const params = {
  access_token: 'xxx', // 客户端传到自己服务器的参数
  openid: 'xxx'
}
// 字母顺序排序后拼接签名串
const signStr = Object.keys(params).sort().map(key => {
  return `${key}=${params[key]}`
}).join('&')
hmac.update(signStr);
const sign = hmac.digest('hex')
// 最终请求如下链接，其中https://xxxx/xxx为云函数Url化地址
// https://xxxx/xxx?access_token=xxx&openid=xxx&sign=${sign} 其中${sign}为上一步得到的sign值

// 云函数验证签名，此示例中以接受GET请求为例作演示
const crypto = require('crypto')
exports.main = async function (event){

  const secret = 'your-secret-string' // 自己的密钥不要直接使用示例值，且注意不要泄露
  const hmac = crypto.createHmac('sha256', secret);

  let params = event.queryStringParameters
  const sign = params.sign
  delete params.sign
  const signStr = Object.keys(params).sort().map(key => {
    return `${key}=${params[key]}`
  }).join('&')

  hmac.update(signStr);

  if(sign!==hmac.digest('hex')){
    throw new Error('非法访问')
  }

  const {
    access_token,
    openid
  } = params
  const res = await uniCloud.getPhoneNumber({
    provider: 'univerify',
    appid: 'xxx', // DCloud appid
    access_token: access_token,
    openid: openid
  })
  // 返回手机号给自己服务器
  return res
}

# 常见问题

关于Android应用签名问题

Android 应用签名MD5如何获取？查看详情

Android应用签名变更需要注意什么？

未审核通过的一键登录应用可以直接修改签名信息，待审核通过后自动生效。
已经审核通过的应用要修改签名，需要删除一键登录应用，然后重新添加应用。待重新审核通过后，变更的签名才能生效。查看详情

一键登录应用个数超过限制如何申请解除限制？

每个账号均有开通一键登录应用个数的限制(默认为20个)，请合理安排使用。如需提升限额，需先完成企业认证(仅支持面向企业用户提升额度)，然后发邮件到 service@dcloud.io 申请。发送提额邮件时，需说明unicloud.dcloud.net.cn的登录账号，同时需解释公司主营业务，以及为何需要更多的一键登录的额度。

一键登录应用转让问题

查看详情

新添加的一键登录应用要多久审核通过？

应用信息需要运营商审核周期约为1-3个工作日。

获号方法(uniCloud.getPhoneNumber) 遇到的常见的错误

错误描述	解决方案
应用所有者账号信息异常，请检查账号uni一键登录服务是否正常	包含了不必要的参数（apiKey、apiSecret），请删除这两个参数
apiKey值不可为空	1.检查HBuilderX版本为3.94及以上 2. 如下插件需要升级后才不会检查apiKey、apiSecret必填，如果使用uni-id公共模块需要更新到3.3.31版本，如果使用uni-id-pages需要更新到1.1.17版本，如果使用了uni-starter需要更新到2.1.6版本
获取手机号失败，请稍后重试	请加群反馈，加群方式见“常见问题”下方