一.准备工作

概述

本文是闪验SDK_Android v2.3.3版本的接入文档，用于指导SDK的集成使用。在对接之前您需要花5-10分钟阅读以下条目，可减少对接过程中的问题。

• 常见问题请移步至「对接问题」
• 升级版本请移步至「升级指南」

• 下载SDK资源请移步至「资源下载」

合规性说明

1、您需要确保App有《隐私政策》，并且在用户首次启动App时就弹出《隐私政策》取得用户同意。

2、您务必告知用户您选择创蓝SDK服务，请在《隐私政策》中增加如下参考条款：

“我们的产品为改善注册及登录界面用户体验，集成第三方SDK一键登录服务：闪验SDK，用于帮助实现用户一键登录行为。为了实现网关取号技术，闪验SDK需要获取IP地址、网卡（MAC)地址、国际移动设备识别码（IMEI）、OAID（替代IMEI）、sim卡信息，并会收集手机机型、系统类型、系统版本、网络环境、网关取号报错日志等数据以提供统计分析服务能力，并可提供反欺诈等功能。”

3、您务必确保用户同意《隐私政策》之后，再初始化创蓝SDK。具体初始化步骤详见下文。

前置条件

• 闪验SDK支持minSdkVersion 16及以上版本
• 闪验SDK支持中国移动3/4G/5G、联通3/4G/5G、电信4G/5G的取号能力，在3G网络下时延会更高

• 闪验SDK支持单数据网络/数据网络与WiFi网络双开，不支持单WiFi网络
• 对于双卡手机，闪验SDK只对当前流量卡取号，双卡均未开数据流量SDK将会返回错误码

创建应用

应用的创建流程及APPID的获取，请查看「账号创建」文档

注意：如果应用有多个包名或签名不同的马甲包，须创建多个对应包名和签名的应用，否则马甲包将报包名或签名校验不通过。

快速体验demo

• Android压缩包中的apk文件夹中是闪验demo的安装包，可以直接安装到Android手机上。并快速体验闪验在您手机上的表现。
• Android压缩包中的demo文件夹中是闪验的示例工程源码，使用Android studio打开完成以下步骤配置，可直接运行起来测试。

a.将build里面的applicationId换成对应的测试包名

b.将签名配置改成您的签名配置

c.将AppId换成您在闪验平台创建应用后生成的信息

开发环境搭建

（1）将开发包拷贝到工程

a.将SDK中libs目录下的aar包拷贝到您工程的libs目录下，如没有该目录需新建。

并在build文件的dependencies中添加aar包依赖：

repositories {
    flatDir {
        dirs '../app/libs'
    }
}
dependencies {implementation fileTree(include: ['*.aar'], dir: 'libs')}

b.SDK中jniLibs目录下的so库复制到您工程的jniLibs目录下，如没有该目录需新建。

jniLibs所在目录结构如下图：

注意：系统默认读取jniLibs目录下的so库，如果您的项目中在build里面指定了 jniLibs.srcDirs =['libs']，则必须

将so库放到libs目录下，否则so库会引用不到，导致电信卡预取号报："result":80102,"msg":"预登录异常"。

SDK提供了多个架构的so库，可根据项目需求选择相应的so库。如果您的项目只包含某个目录，则复制对应目录的so

库，例如，您的项目中只有armeabi-v7a目录，则只复制jniLibs中的armeabi-v7a目录下的so库到您的项目。

（2）配置AndroidManifest.xml文件

必要权限：

<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.WRITE_SETTINGS"/>
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/>
<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"/>
<uses-permission android:name="android.permission.GET_TASKS"/>

建议的权限：如果选用该权限，需要在预取号步骤前提前动态申请。

<uses-permission android:name="android.permission.READ_PHONE_STATE"/>

建议开发者申请本权限，本权限只用于移动运营商在双卡情况下，更精准的获取数据流量卡的运营商类型，缺少该权限，存在取号失败概率上升的风险。

配置权限说明

在application标签内配置授权登录activity，screenOrientation和theme可以根据项目需求自行修改

<activity
    android:name="com.chuanglan.shanyan_sdk.view.CmccLoginActivity"
    android:configChanges="keyboardHidden|orientation|screenSize"
    android:launchMode="singleTop"
    android:screenOrientation="behind"
     />

<activity-alias
   android:name="com.cmic.sso.sdk.view.LoginAuthActivity"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:launchMode="singleTop"
   android:screenOrientation="behind"
   android:targetActivity="com.chuanglan.shanyan_sdk.view.CmccLoginActivity"
    /> 
<activity
   android:name="com.chuanglan.shanyan_sdk.view.ShanYanOneKeyActivity"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:launchMode="singleTop"
   android:screenOrientation="behind"
    />
<activity
   android:name="com.chuanglan.shanyan_sdk.view.CTCCPrivacyProtocolActivity"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:launchMode="singleTop"
   android:screenOrientation="behind"
    /> 

配置Android9.0对http协议的支持两种方式：

方式一：

android:usesCleartextTraffic="true"

示例代码：

<application
    android:name=".view.MyApplication"
    ***
    android:usesCleartextTraffic="true"
    ></application>

方式二：

运营商个别接口为http请求，对于全局禁用Http的项目，需要设置Http白名单。以下为运营商http接口域名：cmpassport.com；10010.com

(3) 混淆规则：

-dontwarn com.cmic.sso.sdk.**
-dontwarn com.unikuwei.mianmi.account.shield.**
-dontwarn com.sdk.**
-keep class com.cmic.sso.sdk.**{*;}
-keep class com.sdk.** { *;}
-keep class com.unikuwei.mianmi.account.shield.** {*;}
-keep class cn.com.chinatelecom.account.api.**{*;}

(4) AndResGuard资源压缩过滤：

"R.anim.umcsdk*",
"R.drawable.umcsdk*",
"R.layout.layout_shanyan*",
"R.id.shanyan_view*",

通过上面的几个步骤，工程就配置完成了，接下来就可以在工程中使用闪验SDK进行开发了。

二.一键登录api

1.初始化

调用SDK其他方法前，请确保已调用过初始化，否则会失败。（会采集信息，建议放到同意协议后调用）

方法原型

public void init(Context context, String appId, InitListener initListener){}

参数描述

示例代码

   OneKeyLoginManager.getInstance().init(getApplicationContext(), appId, new InitListener() {
                            @Override
                            public void getInitStatus(int code, String result) { 
                            }
                        });

getInitStatus(int code, String result)方法返回参数分为外层code和result，含义如下：

注意：初始化不要放在申请权限方法内，否则用户拒绝权限会造成后续方法没有回调。

2.预取号

• 建议在判断当前用户属于未登录状态时使用，已登录状态用户请不要调用该方法
• 建议在执行拉取授权登录页的方法前，提前一段时间调用预取号方法，中间最好有2-3秒的缓冲（因为预取号方

法需要1~3s的时间取得临时凭证），比如放在启动页的onCreate（）方法中。

• 请勿频繁的多次调用、请勿与拉起授权登录页同时或之后调用。
• 避免大量资源下载时调用，例如游戏中加载资源或者更新补丁的时

方法原型：

public void getPhoneInfo(GetPhoneInfoListener getPhoneInfoListener){}

参数描述

示例代码：

OneKeyLoginManager.getInstance().getPhoneInfo(new GetPhoneInfoListener() {
    @Override
    public void getPhoneInfoStatus(int code, String result) {
    }
});

getPhoneInfoStatus(int code, String result)方法返回参数分为外层code和result，含义如下：

3.拉起授权页

• 拉起授权页方法将会调起运营商授权页面。已登录状态请勿调用 。
• 每次调用拉起授权页方法前均需先调用授权页配置方法，否则授权页可能会展示异常。

• 1秒之内只能调用一次，而且必须保证上一次拉起的授权页已经销毁再调用，否则SDK会返回请求频繁。

方法原型：

public void openLoginAuth(boolean isFinish, OpenLoginAuthListener openLoginAuthListener, OneKeyLoginListener oneKeyLoginListener){}

参数描述

示例代码

OneKeyLoginManager.getInstance().openLoginAuth(false, new OpenLoginAuthListener() {
    @Override
    public void getOpenLoginAuthStatus(int code, String result) {
    }
}, new OneKeyLoginListener() {
    @Override
    public void getOneKeyLoginStatus(int code, String result) {
    }
});

getOpenLoginAuthStatus(int code,String result)方法返回参数分为外层code和result，含义如下：

getOneKeyLoginStatus(int code,String result)方法返回参数分为外层code和result，含义如下：

当外层code为1000时，result的返回为

{
"token": ""
}

含义如下：

4.销毁授权页

A.授权页面自动销毁

1.在授权登录页面，当用户主动点击左左上角返回按钮时，返回码为1011，SDK将自动销毁授权页；

2.安卓 SDK，当用户点击手机的硬件返回键（相当于取消登录），返回码为1011，SDK将自动销毁授权页

3.当用户设置一键登录或者其他自定义控件为自动销毁时，得到回调后，授权页面会自动销毁

B.授权页手动销毁

1.当设置一键登录为手动销毁时，点击授权页一键登录按钮成功获取token不会自动销毁授权页，请务必在回调中处理完自己的逻辑后手动调用销毁授权页方法。

2.当设置自定义控件为手动销毁时，请务必在回调中处理完自己的逻辑后手动调用销毁授权页方法。

方法原型

public void finishAuthActivity(){}

示例代码

OneKeyLoginManager.getInstance().finishAuthActivity();

注意：销毁授权页时，请不要在销毁后回到的界面主线程中做耗时操作，避免堵塞授权页onDestroy方法，导致再次调用拉起授权页时报请求频繁。

5.授权页点击事件监听

需要对授权页点击事件监听的用户，可调用此方法监听授权页点击事件，无此需求可以不写。

方法原型

public void setActionListener(ActionListener actionListener) {}

参数描述

示例代码

   OneKeyLoginManager.getInstance().setActionListener(new ActionListener() {
            @Override
            public void ActionListner(int type, int code, String message) {
            }
        });

ActionListners(int type,int code,String message)方法返回参数含义如下：

6.其他API

a.设置授权页loading显示隐藏

方法原型

public void setLoadingVisibility(boolean visibility) {}

参数描述

示例代码

 OneKeyLoginManager.getInstance().setLoadingVisibility(false);

b.设置授权页协议复选框状态

授权页拉起之后调用有效，本方法仅在授权页拉起后想改变CheckBox状态时使用，设置进入授权页的默认状态请使用授权页配置ShanYanUIConfig里面的setPrivacyState方法

方法原型

public void setCheckBoxValue(boolean isChecked) {}

参数描述

示例代码

 OneKeyLoginManager.getInstance().setCheckBoxValue(false);

c.清理预取号缓存

方法原型：

public void clearScripCache(Context context)

示例代码：

OneKeyLoginManager.getInstance().clearScripCache(getApplicationContext());

d.获取运营商类型

方法原型：

public String getOperatorType(Context context)

示例代码：

OneKeyLoginManager.getInstance().getOperatorType(getApplicationContext());

返回值4种：CMCC、CUCC、CTCC、UNKNOWN_OPERATOR；

释义：CMCC（移动）；CUCC（联通）；CTCC（电信）；UNKNOWN_OPERATOR（未知）

7.置换手机号

当一键登录外层code为1000时，您将获取到返回的参数，请将这些参数传递给后端开发人员，并参考「服务端」文档来实现获取手机号码的步骤。

8.授权页界面修改

a.设计规范

注意：开发者不得通过任何技术手段，将授权页面的隐私栏、号码栏内容隐藏、覆盖，对于接入闪验SDK并上线的应用，我方和运营商会对授权页面做审查，如果有出现未按要求设计授权页面，我方有权将应用的登录功能下线。

b.授权页配置

调用该方法可实现对三网运营商授权页面个性化设计，配置一次有效，每次调用拉起授权页方法前必须先调用该方法，否则授权界面会展示异常，具体实现可参考demo示例的ConfigUtils配置类。（三网界面配置内部实现逻辑不同，请务必使用移动、联通、电信卡分别测试三网界面）

方法原型

public void setAuthThemeConfig(ShanYanUIConfig shanPortraitYanUIConfig, ShanYanUIConfig shanLandYanUIConfig) {}

参数说明

示例代码

OneKeyLoginManager.getInstance().setAuthThemeConfig(ConfigUtils.getCJSConfig(getApplicationContext()), ConfigUtils.getCJSLandscapeUiConfig(getApplicationContext()))

ShanYanUIConfig.java配置元素说明

授权页背景配置三选一，支持图片，gif图，视频

授权页整体属性

授权页状态栏

授权页导航栏（高度：50dp）

授权页logo

授权页号码栏

授权页登录按钮

授权页隐私栏

授权页slogan（**提供认证服务）

授权页创蓝slogan（创蓝253提供技术支持；默认：隐藏）

授权页loading

授权页相对控件设置（指定在登录按钮和协议栏之间；默认铺满按钮和协议之间区域）

协议页导航栏及状态栏设置

授权页遮盖层

隐私协议提示弹框

注意：

a.控件X偏移如果不设置默认居中。

c.添加自定义控件

调用该方法可实现在授权页添加自定义控件。

方法原型

public ShanYanUIConfig.Builder addCustomView(View view, boolean isFinish, boolean type, ShanYanCustomInterface shanYanCustomInterface) {}

参数说明

注意：如果添加布局为自定义控件，监听实现请参考demo示例。

d.设置弹窗样式

调用该方法可实现将授权页设置成弹窗样式。

方法原型

public ShanYanUIConfig.Builder setDialogTheme(boolean isdialogTheme, int dialogWidth, int dialogHeight, int dialogX, int dialogY ,boolean isDialogBottom) {}

参数说明

注意：设置弹窗效果背景的透明度需要在Manifest.xml里面配置授权界面样式

样式示例：

1.为授权界面的activity设置弹窗theme主题

 <activity
    android:name="com.chuanglan.shanyan_sdk.view.CmccLoginActivity"
    android:configChanges="keyboardHidden|orientation|screenSize"
    android:launchMode="singleTop"
    android:screenOrientation="behind"
    android:theme="@style/Theme.ActivityDialogStyle" />

<activity-alias
   android:name="com.cmic.sso.sdk.activity.LoginAuthActivity"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:launchMode="singleTop"
   android:screenOrientation="behind"
   android:targetActivity="com.chuanglan.shanyan_sdk.view.CmccLoginActivity"
    android:theme="@style/Theme.ActivityDialogStyle" /> 
<activity
   android:name="com.chuanglan.shanyan_sdk.view.ShanYanOneKeyActivity"
   android:configChanges="keyboardHidden|orientation|screenSize"
   android:launchMode="singleTop"
   android:screenOrientation="behind"
    android:theme="@style/Theme.ActivityDialogStyle" />

2.设置theme主题的style样式

<style name="Theme.ActivityDialogStyle" parent="Theme.AppCompat.Light.NoActionBar">
    <!--背景透明-->
    <item name="android:windowBackground">@android:color/transparent</item>
    <item name="android:windowIsTranslucent">true</item>
    <!--dialog的整个屏幕的背景是否有遮障层-->
    <item name="android:backgroundDimEnabled">true</item>
</style>

注意：如果需要触摸弹窗外部销毁授权页，style的parent请使用系统dialog相关主题。

e.设置横竖屏

在manifest文件中，指定授权页activity的screenOrientation即可

注意：只有全屏不透明的activity才能指定方向，否则在8.0系统版本上会报“Only fullscreen opaque activities can request orientation”或其他异常。

即：弹框或者透明主题，授权页不能指定方向。如需指定方向，可以指定授权页前个页面的方向，授权页设置跟随前个界面方向，即：“android:screenOrientation="behind"”

三.本机校验api

注：本机认证同免密登录，需要初始化，本机认证、免密登录可共用初始化，两个功能同时使用时，只需调用一次初始化。

1.初始化

同SDK使用说明-->初始化

2.本机校验获取token

在初始化执行之后调用，本机号校验界面需自行实现，可以在多个需要校验的页面中调用。

方法原型：

public void startAuthentication(AuthenticationExecuteListener authenticationExecuteListener) {}

参数描述：

示例代码：

 OneKeyLoginManager.getInstance().startAuthentication(new AuthenticationExecuteListener() {
                        @Override
                        public void authenticationRespond(int code, String result) {
                        }
                    });

authenticationRespond(int code,String result)方法返回参数分为外层code和result，含义如下：

当外层code为2000时，result的返回为

{
    "token":""
}

含义如下：

3.校验手机号

当本机号校验外层code为2000时，您将获取到返回的参数，请将这些参数传递给后端开发人员，并参考「服务端」文档来实现校验本机号的步骤

四.返回码