快速找到所需文档，高效完成接入与排障

1. 概述

官网下载SDK后进行解压，解压后包含相关依赖包，分别在两个文件夹中：

a) common

b) verify 

SDK同时包含了本机号码认证和一键登录两个功能。号码认证服务包含本机号码认证和一键登录时两个不同的功能，使用场景不一样，无需一起使用。

本机号码认证使用场景：用户输入手机号码，通过SDK获取token（通过getVerifyToken获取），服务端携带输入的手机号码和token去运营商网关进行校验（服务端调用VerifyMobile接口），返回的结果时用户当前上网使用的号码与输入的号码是否一致。

一键登录使用场景：用户无需输入手机号码，SDK会拉起授权页，用户确认授权后，SDK会获取token（通过getLoginToken获取），服务端携带token到运营商网关获取用户当前上网使用的号码（服务端调用GetMobile接口），并返回给APP服务端。

2. 准备工作

a) 请确保您的终端设备已经开启了4G网络（联通、移动支持3G网络，但接口耗时会增加）

b) 请确保已经在友盟+控制台开通了号码认证服务并创建了对应的方案，点击进入控制台。

c) 您也可以点击查看完整使用流程。

d）欢迎观看友盟学院出品《U-Verify安卓端集成操作》，帮助开发者快速集成。

3. 运行demo工程

您可以直接运行解压后的demo工程。Demo工程

4. 开发环境搭建

1) maven自动集成

在工程build.gradle配置脚本中buildscript和allprojects段中添加【友盟+】SDK新maven仓库地址。

maven { url 'https://repo1.maven.org/maven2/' }

buildscript {
    repositories {
        google()
        jcenter()
        maven { url 'https://repo1.maven.org/maven2/' }
}
    dependencies {
        classpath 'com.android.tools.build:gradle:3.4.0'

// NOTE: Do not place your application dependencies here; they belong
// in the individual module build.gradle files
}
}

allprojects {
    repositories {
        google()
        jcenter()
        maven { url 'https://repo1.maven.org/maven2/' }
}
}

在工程App 对应build.gradle配置脚本dependencies段中添加common SDK库和认证库依赖：

dependencies {

implementation  'com.umeng.umsdk:common:+'// 必选
implementation  'com.umeng.umsdk:asms:+'// 必选
implementation  'com.umeng.umsdk:uverify:+'// 必选
implementation  'com.umeng.umsdk:uverify-main:+'// 必选
implementation  'com.umeng.umsdk:uverify-logger:+'// 必选
implementation  'androidx.appcompat:appcompat:1.3.1'（最低版本）
}

2) 手动集成

下载SDK并解压后，将aar拷贝至工程的libs目录下。强依赖包：

1. umeng-uverify-2...aar

2. umeng-common-9...jar

3. umeng-asms-armeabi-v1...aar  

4. umeng-logger-2.x.x.aar

5. umeng-main-2.x.x.aar

6. 以及动态引入v7包：com.android.support:appcompat-v7:27.1.1（最低版本）

3) 配置Android9.0对http协议的支持方式

在res/xml目录新建网络安全配置文件：network_security_config.xml

<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
    <domain-config cleartextTrafficPermitted="true">
        <domain includeSubdomains="true">enrichgw.10010.com</domain>
    </domain-config>
</network-security-config>

在app项目AndroidManifest.xml中application节点增加启用明文传输数据的配置

<application android:networkSecurityConfig="@xml/network_security_config" >

4) 相关调用函数

/**
 *  为满足工信部合规要求，请确保按照合规指南进行预初始化
 *  https://developer.umeng.com/docs/119267/detail/182050
 */
UMConfigure.preInit(this, "替换为Appkey,服务后台位置：应用管理 -> 应用信息 -> Appkey", "渠道信息");

/*
* 0.在Application的onCreate方法中初始化Appkey等信息
*/
UMConfigure.init(this,"替换为Appkey,服务后台位置：应用管理 -> 应用信息 -> Appkey","渠道信息",UMConfigure.DEVICE_TYPE_PHONE,"");
/*
* 1.初始化获取token实例
*/
mTokenListener =new UMTokenResultListener(){}
/*
*   2.初始化SDK实例
*/
umVerifyHelper = UMVerifyHelper.getInstance(context, mTokenListener);
/*
*   3.设置SDK密钥
*/
umVerifyHelper.setAuthSDKInfo();
/*
*   4.检测终端网络环境是否支持一键登录或者号码认证
*/
umVerifyHelper.checkEnvAvailable();
/*
*   5.若步骤4支持，则根据业务情况，调用预取号或者一键登录接口
*     详见demo接入工程
*/
umVerifyHelper.getLoginToken(context,5000);

5) 混淆keep规则

-keep class com.umeng.**{*;}

-keepclassmembers class*{
public <init> (org.json.JSONObject);
}

-keepclassmembers enum*{
public static **[] values();
public static ** valueOf(java.lang.String);
}

6）资源混淆配置

若您需要开启资源混淆，则需要在相应工程的res/raw/keep.xml文件中加入以下代码

tools:keep="@drawable/authsdk*, 
@drawable/umcsdk*,
@layout/widget_pns_*,
@layout/umcsdk*,
@anim/authsdk*, 
@anim/umcsdk*, 
@theme/authsdk_*,
@id/pns_*,
@id/authsdk*,
@id/umcsdk*,
@color/pns_*, 
@dimen/pns_*,
@string/umcsdk*,
@style/umcsdk*"

7）权限列表

<uses-permission android:name="android.permission.INTERNET"/> <!--网络访问-->
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/> <!--检查wifi网络状态-->
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/> <!--检查网络状态-->
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE"/> <!--切换网络通道-->
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/> <!--开关wifi状态，解决国内机型移动网络权限问题需要-->

5. 智能认证SDK方法说明

5.1 获取认证实例(getInstance)

/**
     * 函数名：getInstance
     * @param context
     * @param tokenResultListener
     * @return UMVerifyHelper 实例
     */
public static UMVerifyHelper getInstance(Context context, UMTokenResultListener tokenResultListener)

5.2设置SDK密钥（setAuthSDKInfo）

/**
  * 设置SDK密钥信息
  * @param secret 密钥信息 需要从服务端获取
  */
public void setAuthSDKInfo(String secret)

5.3检查终端是否支持号码认证(checkEnvAvailable)

/**
     * SDK环境检查函数，检查终端是否支持号码认证，通过UMTokenResultListener返回code
     * @param type 1:本机号码校验 2：一键登录
     * 600024 终端支持认证
     * 600013 系统维护，功能不可用
     */
public void checkEnvAvailable(@IntRange(from =1, to =2)int type)

5.4关键日志开关（setLoggerEnable）

/**
     * 设置SDK 是否开启日志
     * @param isDebug 为true则输出关键步骤运行日志
     */
public void setLoggerEnable(boolean isDebug)

5.5本机号码认证获取token（getVerifyToken）

/**
     * 获取本机号码校验token
     * @param timeout 超时时间，单位ms
     */
public void getVerifyToken(int timeout)

5.6一键登录预取号（accelerateLoginPage）

/**
     *预取号码信息，建议在 APP 登录页初始化时调用，提高后续授权页的打开速度。
     *不要在 App 启动初始化时调用，避免接口调用资源浪费
     *@param overdueTime 预取信息有效期 单位ms
     *@param listener 预取结果回调函数
     */
public void accelerateLoginPage(final int overdueTime, final UMPreLoginResultListener listener)

5.7一键登录唤起授权页（getLoginToken）

/**
     *唤起一键登录授权页面，在用户授权后获取一键登录的 Token
     *@param timeout 超时时间 单位 ms
     */
public void getLoginToken (int timeout)

5.8退出授权页（quitLoginPage）

/**
     * 退出登录授权页,授权页的退出完全由APP 控制
     * SDK 完成回调后，不会立即关闭授权页面，需要开发者主动调用离开授权页面方法去完成页面的关闭
     */
public void quitLoginPage()

5.9退出授权时关闭加载状态（hideLoginLoading）

/**
     * 退出登录授权页时，授权页的loading消失由APP控制
     * SDK 完成回调后，不会立即关闭授权页面，需要开发者主动调用离开授权页面方法去完成页面的关闭
     * SDK回调完成后，不会立即关闭loading dialog，需要开发者主动调用loading效果方法去关闭loading dialog
     */
public void hideLoginLoading()

5.10授权页物理返回键禁用

/**
* 授权页物理返回键禁用
* true禁用，false不禁用，默认false
*
* @param close
*/
public void closeAuthPageReturnBack(boolean close)

5.11横屏水滴屏全屏适配

/**
* 横屏水滴屏全屏适配
* true适配，false不适配，默认false
*
* @param fullScreen
*/
public void keepAuthPageLandscapeFullScreen(boolean fullScreen) 

5.12授权页扩大协议按钮选择范围至我已阅读并同意

/**
* 授权页扩大协议按钮选择范围至我已阅读并同意
* true开启，false不开启，默认false
*
* @param expandScope
*/
public void expandAuthPageCheckedScope(boolean expandScope)

5.13一键登录页面添加由XML的自定义控件(addAuthRegisterXmlConfig)

/**
     * 动态添加控件
     *
     * @param authRegisterXmlConfig 自定义布局，可以设置控件的位置和相关处理逻辑
     */
public void addAuthRegisterXmlConfig(UMAuthRegisterXmlConfig authRegisterXmlConfig)

初始化 addAuthRegisterXmlConfig 类时需要先调静态内部类Builder()里面的 2 个方法

• setLayout： 开发者传入自定义的控件的xml资源ID

• UMAbstractPnsViewDelegate：授权页使用xml添加自定义布局时，可以配合该Delegate类实现xml中相关view的操作，比如事件监听以及动态UI改动等等，当xml对应的view加载后SDK将调用onViewCreated(View)方法通知view已经创建OK，此时可以获取xml中的view并进行相关事件绑定等操作

5.14一键登录添加自定义控件（addAuthRegistViewConfig）

/**
     * 动态添加控件
     * @param viewID 开发者自定义控件名称
     * @param viewConfig  配置开发者自定义控件的控件来源、位置和处理逻辑
     */
public void addAuthRegistViewConfig(String viewID, UMAuthRegisterViewConfig viewConfig)

注意：每次调用 getVerifyToken 授权请求之前，都需初始化一次UMAuthRegisterViewConfig,因为在授权页关闭时都会清空注入进去的UMAuthRegisterViewConfig,具体实现请见 demo 工程。初始化 AuthRegisterViewConfig 类时需要先调静态内部类Builder()里面的 3 个方法

• setView： 开发者传入自定义的控件，开发者需要提前设置好控件的布局属性，SDK 只支持 RelativeLayout 布局

• setRootViewId：设置控件的位置，目前SDK 授权页允许在3个位置插入开发者控件RootViewId.ROOT_VIEW_ID_TITLE_BAR，标题;RootViewId.ROOT_VIEW_ID_BODY，授权页空白处，RootViewId.ROOT_VIEW_ID_NUMBER，手机掩码处

• setCustomInterface：设置控件事件

获取 token 成功之后，需把通过setView()注入进去的view 置为 null。

5.15 一键登录修改授权页主题（setAuthUIConfig）

/**
     * 可以自行设置一键登录页面元素
     * @param authUIConfig
     */
public void setAuthUIConfig(UMAuthUIConfig authUIConfig)

5.16 SDK回调接口

获取token回调

public interface UMTokenResultListener {

    /**
     * 授权页唤起成功或获取token成功
     * @param ret 返回码
     */
    void onTokenSuccess(String ret);

    /**
     * 获取token失败
     * @param ret 返回信息
     */
    void onTokenFailed(String ret);

}

获取预取号码回调

public interface UMPreLoginResultListener {
    /**
     *
     * @param vendor 返回预取成功运营商
     */
    void onTokenSuccess(String vendor);

    /**
     *
     * @param vendor 返回预取失败运营商
     * @param ret 返回失败原因
     */
    void onTokenFailed(String vendor, String ret);
}

SDK返回码

5.17获取运营商信息（getCurrentCarrierName）

/**
     * 返回默认上网卡运营商
     * @return CMCC-中国移动 CTCC-中国电信 CUCC-中国联通
     */
public String getCurrentCarrierName()

5.18授权页点击事件回调说明

public interface UMAuthUIControlClickListener{
/**
     * @param code 一键登录页面控件点击事件code
     * @param context Android上下文
     * @param jsonObjectStr 点击事件返回的具体内容json串，不同控件返回的事件内容有所不同
     */
void onClick(String code, Context context, String jsonObjectStr);
}

授权页点击事件响应码

5.19 二次弹窗相关

选调方法：添加二次弹窗自定义布局

在调用addPrivacyRegisterXmlConfig前，调用removePrivacyRegisterXmlConfig先移除所有添加的自定义View。

/**
 * 添加二次弹窗自定义布局
 *
 * @param xmlConfig
 */
@AuthNumber
public void addPrivacyRegisterXmlConfig(AuthRegisterXmlConfig xmlConfig)

选调方法：二次弹窗取消事件

/**
 * 二次弹窗取消事件
 *
 * @param
 */
@AuthNumber
public void quitPrivacyPage() 

选调方法：移除二次弹窗所有自定义布局

/**
 * 移除二次弹窗所有的自定义布局
 */
@AuthNumber
public void removePrivacyRegisterXmlConfig()

使用示例

mAuthHelper.removePrivacyRegisterXmlConfig();
mAuthHelper.addPrivacyRegisterXmlConfig(new AuthRegisterXmlConfig.Builder()
            //此处需改为用户自定义的布局ID
            .setLayout(null, new AbstractPnsViewDelegate() {
            @Override
            public void onViewCreated(View view) {
                //此处可进行用户自定义布局业务逻辑处理
            }
        })
        .build());

选调方法：二次弹窗动态添加控件

/**
 * 动态添加控件
 *
 * @param viewID view的ID
 * @param viewConfig view的动态配置
 */
public void addPrivacyAuthRegistViewConfig(String viewID, AuthRegisterViewConfig viewConfig) 

使用示例

 mAuthHelper.addPrivacyAuthRegistViewConfig(""/**view ID */, new AuthRegisterViewConfig.Builder()
                  //此处需改为用户自定义添加的view
                 .setView(null)
                 //AuthRegisterViewConfig.RootViewId.ROOT_VIEW_ID_BODY 协议文本区域      
                 //AuthRegisterViewConfig.RootViewId.ROOT_VIEW_ID_TITLE_BAR 导航栏部分   
                 //AuthRegisterViewConfig.RootViewId.ROOT_VIEW_ID_NUMBER 确认按钮区域   
                .setRootViewId(AuthRegisterViewConfig.RootViewId.ROOT_VIEW_ID_BODY)
                .setCustomInterface(new CustomInterface() {
                    @Override
                    public void onClick(Context context) {
                        //此处可进行用户自定义view点击事件业务逻辑处理
                    }
                }).build());

选调方法：移除所有动态添加的控件

在调用addPrivacyAuthRegistViewConfig之前调用removePrivacyAuthRegisterViewConfig先移除所有动态添加的控件。

/**
 * 移除所有动态添加的控件
 */
public void removePrivacyAuthRegisterViewConfig()

使用示例

 mAuthHelper.removePrivacyAuthRegisterViewConfig();

5.20 选调方法：获取授权页协议勾选框选中状态

/**
 * 获取授权页协议勾选框选中状态
 */
public boolean queryCheckBoxIsChecked()

使用示例

boolean checked = mPhoneNumberAuthHelper.queryCheckBoxIsChecked();

5.21 选调方法：用户控制返回键及左上角返回按钮效果

调用此方法后用户在setUIClickListener方法中收到ResultCode.CODE_ERROR_USER_CANCEL回调后控制授权页关闭逻辑。

    /**
     * 授权页返回由用户控制
     */
    public void userControlAuthPageCancel()

使用示例

 mPhoneNumberAuthHelper.userControlAuthPageCancel();

5.22 选调方法：用户禁止使用utdid

调用该方法后移除相关utdid的使用。

   /**
     * 禁止使用utdid
     */
    public void prohibitUseUtdid()

使用示例

mPhoneNumberAuthHelper.prohibitUseUtdid();

5.23 选调方法：授权页是否跟随系统深色模式

   /**
     * 授权页界面是否跟随系统深色模式，默认true跟随
     */
    public void setAuthPageUseDayLight(boolean authPageUseDayLight)

使用示例

mPhoneNumberAuthHelper.setAuthPageUseDayLight(true);

5.24 选调方法：删除预取号码信息

   /**
     * 删除预取号码信息
     */
    @AuthNumber
    public void clearPreInfo()

使用示例

mPhoneNumberAuthHelper.clearPreInfo();

6. SDK方法说明

6.1授权页面示例图

一键登录页面

重要涉及图片路径的参数，仅为图片名称（不带路径或后缀名），并且图片需要放置在drawable、drawable-xxhdpi等目录下。

弹窗页面

页面说明如下：

二次授权弹窗页面

6.2 授权页配置说明

6.2.1 授权页导航栏

6.2.2 授权页Logo

6.2.3 授权页Slogan

6.2.4 授权页号码栏

6.2.5 授权页登录按钮

6.2.6 授权页隐私栏

6.2.7 切换方式控件

6.2.8 页面相关函数

6.2.9 配置二次授权弹窗页面

6.3 关闭接口说明

如希望关闭设备ID采集，请参照以下方式

// IMSI采集开关接口
// 参数flag: true-允许采集IMSI；false-不允许采集IMSI
public static void enableImsiCollection(boolean flag);

// ICCID采集开关接口
// 参数flag: true-允许采集ICCID；false-不允许采集ICCID
public static void enableIccidCollection(boolean flag);

// IMEI采集开关接口
// 参数flag: true-允许采集IMEI；false-不允许采集IMEI
public static void enableImeiCollection(boolean flag);