更新记录

1.0.0（2024-11-25）

• 新建号码认证uts插件

平台兼容性

号码认证

网易易盾 提供直连三大运营商，一步校验手机号与当前 SIM 卡号一致性。优化注册/登录/支付等场景验证流程
了解更多产品信息或体验试用，请访问 号码认证产品页

更新提醒

• 在使用前请确保已申请到易盾一键登录的业务id

平台支持（兼容性）

资源引入/集成

从 dcloud 插件市场下载对应插件 yidun-quickpass。导入插件之后一定要自定义基座方可生效，自定义基座说明请参考 https://ask.dcloud.net.cn/article/35115

调用示例

<template>
  <view>
    <button @click="initLogin('quickLogin')">初始化</button>
    <button @click="verifyNumber">授权验证</button>
  </view>
</template>

<script>
 import {
    registerWithBusinessID,
    getPhoneNumberCompletion,
    authorizeLoginCompletion
} from '@/uni_modules/yidun-quickpass'
export default {
    methods: {
        initLogin() {
            // 初始化
            registerWithBusinessID({
                    businessId: '从易盾获取业务id',
                    timeout: 3000
                }, onResponse: (success) => {
                    // 回调处理
                    if (success) {} else {}
                })
        },
        // 预取号
        verifyNumber() {
            getPhoneNumberCompletion({
                onSuccess: (token, mobile) => {
                    // TODO: 预取号成功处理，可以进行调起授权页
                    authorizeLoginCompletion({
                        onSuccess: (token, accessToken) => {},
                        onError: (token, code, msg) => {},
                        onCancel: () => {}
                    })
                },
                onError: (toekn, msg) => {}
            })
        }
    }
</script>

更多使用场景请参考 demo

SDK 方法说明

在 yidun-quickpass 中引入 api

import { 
    registerWithBusinessID, 
    shouldQuickLogin, 
    getPhoneNumberCompletion,
    setCustomView,
    authorizeLoginCompletion,
    closeAuthController,
    numberVerify
} from '@/uni_modules/yidun-quickpass'

1. 初始化

初始化一键登录

代码说明：

registerWithBusinessID({
  businessId: //'从易盾获取的id',
  timeout: 3000
}, {
    onResponse: (success) => {
        if (success) {
        } else {
        }
    }
})

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  businessId	String	是	无	易盾分配的业务 id
  debug	boolean	否	false	是否打开日志开关
  timeout	Number	否	3	运营商预取号和授权登录接口的超时时间，单位秒

• 回调说明：

  onResponse: (success) => {
  if (success) {
      // 初始化成功
  } else {
      // 初始化失败
  }
  }

2. 检查网络环境

检测网络状况等条件是否具备进行一键登录

代码说明：

let ret = shouldQuickLogin()

返回值说明：

• 返回值说明：

  返回值	类型	描述
  ret	boolean	是否具备一键登录网络环境，true具备，false不具备

3. 预取号

代码说明：

getPhoneNumberCompletion({
    onSuccess: (token, mobile) => {
        // 预取号成功
    },
    onError: (token, msg) => {
        // 预取号失败
    }
})

参数说明：

• 回调参数说明：

  回调参数	类型	描述
  token	String	易盾token，用于校验
  mobile	String	掩码
  msg	String	预取号异常信息

4. 自定义授权页面

在工程目录下添加 json 配置文件，可配置项参考下面说明

代码说明：

setCustomView(options,{
    onAction: (action, checked) => {
        // 授权页内部view和自定义view点击事件回调
    },
    onLifeCycle: (lifeCycle) => {
        // 页面生命周期
    }
})

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  options	UTSJSONObject	是	无	自定义配置项json字符串

options 可配置项说明： android版

开发者不得通过任何技术手段，将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖
网易易盾与运营商会对应用授权页面进行审查，若发现上述违规行为，网易易盾有权将您的一键登录功能下线
所有使用到的图标请放置在nativeResources/android/res/drawable目录下（命名只支持a-z、0-9和下划线），如果没有请在工程目录下创建，config配置文件中只配置图标的名字

状态栏

导航栏

应用 Logo

手机掩码

认证品牌

登录按钮

隐私协议

协议详情 Web 页面导航栏

其他

自定义view

options 可配置项说明： iOS版

设计规范概览 开发者不得通过任何技术手段，将授权页面的隐私栏、手机掩码号、供应商品牌内容隐藏、覆盖
网易易盾与运营商会对应用授权页面进行审查，若发现上述违规行为，网易易盾有权将您的一键登录功能下线

基础配置

转场动画

自定义控件

"widgets": [
        {
           "type": "UIButton", 
           "UIButtonType": 0, 
           "image": "static/weixin.png",
           "title": "",    
           "titleColor": "#000000",
           "titleFont": 12,
           "cornerRadius": 20,
           "action": "handleCustomEvent1",
           "frame": {"mainScreenLeftDistance":100,"mainScreenTopDistance":360,"width":32,"height":32},
           "backgroundImage":"static/yidun_logo.png"
        },
        {
            "type": "UIButton",
            "UIButtonType": 0, 
            "image": "static/qq.png",
            "title": "",    
            "titleColor": "#FFFFFF",
            "titleFont": 12,
            "cornerRadius": 20,
            "action": "handleCustomEvent2",
            "frame": {"mainScreenCenterXWithLeftDistance":0,"mainScreenTopDistance":360,"width":32,"height":32},
            "backgroundImage": "static/yidun_logo.png"
        },
        {
            "type": "UIButton",
            "UIButtonType": 0, 
            "image": "static/weibo.png",
            "title": "",
            "titleColor": "#FFFFFF",
            "titleFont": 12,
            "cornerRadius": 20,
            "action": "handleCustomEvent3",
            "frame": {"mainScreenLeftDistance":100,"mainScreenRightDistance":360,"mainScreenTopDistance":32,"height":32},
            "backgroundImage": "static/yidun_logo.png"
        },
        {
            "type": "UILabel",
            "textColor": "#FFFFFF",
            "font": 15,
            "cornerRadius": 20,
            "action": "handleCustomLabel",
            "text": "其他登录方式",
            "textAlignment": 1,
            "frame": {"mainScreenLeftDistance":0,"mainScreenRightDistance":310,"mainScreenBottomDistance":200,"height":32}
        }
    ]

背景设置视频

背景设置 Gif

导航栏

应用 Logo

手机掩码

认证品牌

登录按钮

隐私协议

若勾选框需要展示，请务必设置勾选框的选中态图片与未选中态图片 协议未勾选时，登录按钮是否可点击可以自定义设置，弹窗提示的样式也可以自定义

弹窗模式

• 回调函数说明：

  onAction: (action, checked) => {
      // 授权页内部view和自定义view点击事件回调
      // action当前点击view的名称 cheched 当前复选框的状态（仅在复选框事件和登录按钮点击事件中有效）
  },
  onLifeCycle: (lifeCycle) => {
      // 页面生命周期
  }

  action 取值说明：
  Android
  

• privacy -- 隐私协议点击事件
• checkbox -- 复选框点击事件（含checked: 0/1）
• loginButton -- 登录按钮点击事件（含checked: 0/1）
• leftBackButton -- 左上角返回按钮点击事件

iOS

• loginAction -- 登录按钮点击事件（含checked: 0/1）
• checkedAction -- 复选框事件（含checked: 0/1）
• appDPrivacy -- 默认协议点击事件
• appFPrivacy -- 第一个协议点击事件
• appSPrivacy -- 第二个协议点击事件

lifecycle 取值说明：
Android

• onCreate -- 页面创建
• onStart -- 页面已开始活动
• onResume -- 页面展示
• onPause -- 页面非活动状态
• onStop -- 页面已停止
• onDestroy -- 页面销毁

iOS

• authViewDidLoad -- 加载授权页
• authViewWillAppear -- 授权页已经出现
• authViewWillDisappear -- 授权页将要消失
• authViewDidDisappear -- 授权页已经消失
• authViewDealloc -- 授权页销毁

5. 调起授权页面

代码说明：

authorizeLoginCompletion({
    onSuccess: (token, accessToken) => {
        // 授权成功
    },
    onError: (token, code, msg) => {
        // 授权失败
    },
    onCancel: () => {
        // 用户取消取号
    }
})

参数说明：

• 回调参数说明：

  回调参数	类型	描述
  token	String	易盾授权码
  accessToken	String	运营商授权码，用于置换真实手机号
  code	Number	异常码
  msg	String	异常信息

6. 设置协议复选框

代码说明：

checkedSelected(isChecked)

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  isChecked	boolean	是	无	true:复选框勾选，false:复选框取消勾选

7. 清除缓存

代码说明：

clearScripCache()

8. 关闭授权页

插件内部不会主动关闭授权页，请在 authorizeLoginCompletion 回调中主动调用该函数关闭

代码说明：

closeAuthController()

9. 本机校验

用户输入手机号码后，自动校验与当前本机卡号的一致性，无需发送短信验证码

代码说明：

  numberVerify(mobileNumber,  {
    onSuccess: (token, accessToekn) => {
        // 本机校验成功
    },
    onError: (token, code, msg) => {
        // 本机校验失败
    }
})

参数说明：

• 入参说明：

  参数	类型	是否必填	默认值	描述
  mobileNumber	String	是	无	手机号
  callback	NumberVerifyCallback	是	无	回调

• 回调参数说明：

  回调参数	类型	描述
  token	String	易盾校验码
  accessCode	String	运营商授权码
  code	Number	异常码
  msg	String	异常信息