Android一键登录

1. 概述

• 网络取号时请务必开启手机流量 
1.  电信只支持4G网络取号 
2.  移动, 联通支持4G, 3G, 2G网络取号，但在非4G网络情况下容易取号失败 
• 针对双卡双待手机只取当前流量卡号
• SDK包含一键登录和本机号码校验两个不同的功能，使用场景不一样，无需一起使用。 
• 当前版本：1.2.1 （新增 5.2.17 设置多个开发者隐私条款）
• 下载SDK后进行解压，解压后获取： RLOklSdk.x.x.x.arr

2. Demo快速体验 

• DEMO下载 
• 确保已在容联服务端开通并申请了一键登录服务，获取到了相应的appID（即子账号Id）。 
• 替换 build.gradle(app) 文件中 APP_ID 的值为申请的appID，并确保此appID和应用包名相对应。 

3. 接入SDK的工作配置

3.1 前期准备

• 确保您的终端设备已经开启了4G网络。 
• 确保已经在容联服务端开通了一键登录服务并创建了对应的账号。 

3.2 环境要求

• 建议使用Android Studio2.3及以上版本。 
• JAVA 编译版本 JDK 1.7 及以上版本。 
• sdk支持版本：Android4.0以上。

3.3 导入sdk

• 将解压后的RLOklSdk.x.x.x.arr文件导入您工程下的libs目录下（目前仅支持手动导入）。arr版本号以实际版本为准；

• 在项目的build.gradle下添加如下代码：

repositories { 
    flatDir { 
        dirs 'libs' 
    } 
} 

• 手动将aar包添加依赖： 

implementation(name: 'RLOKlSdk.x.x.x', ext: 'aar') 

3.4 配置工程

3.4.1 权限配置

<!-- 添加权限 --> 
<!-- 允许应用程序联网，用于访问网关和认证服务器 --> 
//允许程序访问WiFi网络状态信息 
<uses-permission android:name="android.permission.INTERNET" /> 
//获取网络状态，判断是否数据、wifi等 
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" /> 
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" /> 
//允许程序改变网络连接状态 
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" 
/> 
//获取imsi用于判断双卡和换卡 
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" 
/> 
//获取imsi用于判断双卡和换卡 
<uses-permission android:name="android.permission.READ_PHONE_STATE" /> 
<!-- 允许应用读写用户的外部存储器--> 
<uses-permission 
android:name="android.permission.WRITE_EXTERNAL_STORAGE" /> 
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" 
/>

• SDK 的权限声明与application同级，因此要放到AndroidManifest.xml清单文件的application节点外。 
• 文档仅提供了几种可选权限，开发者如需使用其他权限，可以参考Android相关文档根据自己的应用添加所需权限。

3.4.2 SDK核心配置

//以下是配置授权页 如果在只需号码验证功能可不配置 
<activity 
    android:name="com.cloopen.okl.sdk.view.CmccLoginActivity" 
    android:configChanges="keyboardHidden|orientation|screenSize" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" /> 
    
<activity 
    android:name="com.cloopen.okl.sdk.view.CuccLoginActivity" 
    android:configChanges="keyboardHidden|orientation|screenSize" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" /> 
    
<activity 
    android:name="cn.com.chinatelecom.account.sdk.ui.AuthActivity" 
    android:configChanges="orientation|keyboardHidden|screenSize" 
    android:enabled="true" 
    android:exported="false" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" /> 
    
<activity 


android:name="cn.com.chinatelecom.account.sdk.ui.MiniAuthActivity" 
    android:configChanges="orientation|keyboardHidden|screenSize" 
    android:exported="false" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" /> 
    
<activity-alias 
    android:name="com.cmic.sso.sdk.activity.LoginAuthActivity" 
    android:configChanges="keyboardHidden|orientation|screenSize" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" 
    
android:targetActivity="com.cloopen.okl.sdk.view.CmccLoginActivity" /> 


<activity-alias 
    android:name="com.unicom.xiaowo.account.shield.ui.LoginActivity" 
    android:configChanges="orientation|keyboardHidden|screenSize" 
    android:launchMode="standard" 
    android:screenOrientation="portrait" 
    
android:targetActivity="com.cloopen.okl.sdk.view.CuccLoginActivity" /> 


<activity 
    android:name="com.cloopen.okl.sdk.view.OneLoginWebActivity"
    android:exported="false" 
    android:launchMode="singleTop" 
    android:screenOrientation="portrait" /> 
    
<activity-alias 


android:name="cn.com.chinatelecom.account.sdk.ui.PrivacyWebviewActivity" 
    android:exported="false" 
    android:screenOrientation="portrait" 
    
android:targetActivity="com.cloopen.okl.sdk.view.OneLoginWebActivity" /> 

3.4.3 配置相应的签名

3.4.4 混淆配置规则

-dontwarn com.cloopen.** 
-keep class com.cloopen.**{*;} 

4. SDK接口说明

4.1 初始化

• 使用一键登录功能前，必须使用开发者自己的 appID 进行初始化SDK 
• 初始化前也可以配置SDKdebug开关打印信息 

/* init: 初始化接口 
        * 参数： 
        * context - Android应用上下文对象 
        * appId - 容联服务端申请的appId 
        * initListener - SDK初始化结果回调接口，InitListener 
        *
        * 说明：示例在应用程序创建时初始化 SDK引用的是Application的上下文， 
        * 开发者可根据开发需要调整。 
        */ 
public void init(Context context, String appId, InitListener initListener) 

//SDK初始化（建议放在Application的onCreate方法中执行） 
OneKeyLoginHelper.getInstance().init(this, BuildConfig.APP_ID,new InitListener() { 
        @Override 
        public void initStatus(String code , String data) { 
        Log.e(TAG,"初始化结果,code:"+code +",data:"+data); 
    } 
}); 

code:000000, 
data:
    {"statusCode":"000000", 
    "statusMsg":"success", 
    "msgId":"cache" 
    } 

4.2 预取号

• 预取当前运营商网络号码信息，该方法会缓存取号信息，建议在 APP 登录页初始化时调用，提高 一键登录效率。
• 调用reqPreLogin接口进行预取号，只有预取号成功才能调用sdk 的 requestToken即可拿到登录的token。 

/* reqPreLogin: 预取号接口 
    * 参数： 
    * timeout - 获取预取号超时时间 单位ms 
    * preLoginListener - 预取号回调监听，preLoginStatus是该监听唯一的 
    抽象方法 
    */ 
public void reqPreLogin(int timeout, PreLoginListener preLoginListener) 

//预选号 
OneKeyLoginHelper.getInstance().reqPreLogin(10000,new 
PreLoginListener() { 
        @Override 
        public void preLoginStatus(String code, String data) { 
        Log.e(TAG,"preLoginStatus,code:"+code +",data:"+data); 
    } 
}); 

code:000000, 
data:
    {"statusCode":"000000", 
    "statusMsg":"success"
    } 

4.3 拉起授权页

• 如果不设置setAuthUIConfifig方法则展示默认的全屏 
• 如果需要全屏自定义UI以及弹窗，需要在调用setAuthUIConfifig授权页之前设置 
• 具体设置请参照 本页 - 授权页面设计条目 

/* setAuthUIConfig: 设置自定义全屏弹窗 
    * 参数： 
    * authUIConfig - 授权页配置 
    */ 
public void setAuthUIConfig(AuthUIConfig authUIConfig) 
/* openAuth: 拉起授权 
    * 参数： 
    * context - 上下文 
    * loginResultListener -授权回调 
    */ 
public void openAuth(Context context, LoginResultListener 
loginResultListener) 

//设置自定义全屏弹窗 
    OneKeyLoginHelper.getInstance().setAuthUIConfig(authUIConfig); 
//拉起授权 
    OneKeyLoginHelper.getInstance().openAuth(context,new 
    LoginResultListener() { 
//获取到token 
    @Override 
    public void loginResult(String code, String data) { 
    Log.e(TAG,"login result,code:"+code + ",data:"+data); 
    } 
});

code:000000, 
data:
    {"resultCode":"0", 
    "token":"xxxxxxxxxxxxxxxxxxxxxxxxx" 
    } 

4.4 退出授权页

/* quitAuthActivity: 退出授权页 
*/ 
public void quitAuthActivity() 

//退出授权页 
OneKeyLoginHelper.getInstance().quitAuthActivity(); 

4.5 日志开关接口

/* setDebug: 配置debug打印开关关接口 
* 参数： 
* flag - true 打印 false不打印 
*/ 
public void setDebug(Boolean flag) 

// SDK配置debug打印开关 
OneKeyLoginHelper.getInstance().setDebug(true); 

4.6 本机号码验证

/* phoneAuth: 本机号码验证 
    * 参数：
    * phoneAuthListener 验证回调 
    */ 
public void phoneAuth(PhoneAuthListener phoneAuthListener) 

// 本机号码验证 
OneKeyLoginHelper.getInstance().phoneAuth(new PhoneAuthListener(){ 
        @Override 
        public void phoneAuthResult(String code, final String data) { 
            Log.e(TAG,"Token of phone auth,code:"+code + ",data:"+data); 
        } 
    }); 

code:000000, 
data: 
    {"resultCode":"0", 
    "token":"xxxxxxxxxxxxxxxxxxxxxxxxx", 
    "operatorType":2 
    } 

5. 授权页面设计

5.1 授权页说明

5.2 拉起授权一键登录全屏/弹窗之前设置自定义UI 

OneKeyLoginHelper.getInstance().setAuthUIConfig(AuthUIConfig 
configBuilder); 

AuthUIConfig.Builder configBuilder= new AuthUIConfig.Builder().build();

5.2.1 设置状态栏颜色，字体颜色  

5.2.2 设置标题栏布局 

• 授权页与协议页面共用

5.2.3 设置标题栏返回按钮相关 (授权页返回相关) 

5.2.4 设置标题栏返回按钮相关 (协议页面返回相关)

5.2.5 设置标题栏中文字相关 

• 授权页与协议页面共用)

5.2.6 设置logo 

5.2.7 设置号码

5.2.8 设置Slogan 

5.2.9 设置登录按钮布局

5.2.10 设置登录按钮文字

5.2.11 设置其他登录方式

5.2.12 设置显示第三方登录点击事件相关

5.2.13 设置隐私条款布局 

5.2.14 设置隐私条款选择框

5.2.15 设置隐私条款字体

5.2.16 设置开发者隐私条款

5.2.17 设置多个开发者隐私条款

5.2.18 设置未同意隐私条款的文字提示

5.2.19 设置隐私协议页面背景图片

5.2.20 设置授权页Activity进入动画和退出动画

5.3 设置弹窗显示

5.3.1 设置授权页使用对话框模式

6. 常见问题

•  初始化失败 

• 检查当前手机运营商是否存在并处于有网络环境 
• 检查是否配置正确的appID 
• 检查清单文件中是否配置相应权限 

• 代码编译问题及授权界面显示异常 

• 检查当前导入的arr文件是否异常 
• 检查配置清单文件中是否配置拉起activity

• Android签名获取指南

• 1、命令行输入以下命令：

 keytool -list -v -keystore C:\xxx\android.keystore.jks

• 2、输入密钥库口令（密码）: 

• 3、获取证书指纹的MD5值（去掉分隔符：”:”）
• 样例：

89D83A.....8G6E5F4B 

• 其他问题 
  • 包签名修改问题？ 
  • 包名和包签名提交后不支持修改，建议直接新建应用 
  • 包签名不一致会有哪些影响？ 
  • SDK会无法使用 
  • 账户正常电信预选号失败？ 
  • 检查App下build.gradle是否配置签名文件，同时删除手机项目，clean Project重新运行。

7. 返回码

7.1 容联SDK返回码

7.2 移动返回码

7.3 联通返回码

7.4 电信返回码