• 끅

    • 商务咨询电话

    • 杭州：19016972238
    • 北京：18201535397
  • 뀩
  • 뀥

    • 申报信息

    • 请购买成功的客户正确填写信息采集表
  • 낃

    • 添加商务微信

  • 녕

一键登录接入指南

一、概述与资源

本产品为 App 实现机主身份验证功能，包含运营商短信验证，本机号一键登录，本机号校验功能。 本机号一键登录是我们的主打推荐产品，为客户提供便捷快速登录操作，短信验证码为一键登录辅助功能。

【说明】： 风控评估能力仅在 V2.3.2 新版本中才可使用。如需使用需开通申请需求。其中风控详细说明见 SDK 中的风控说明文档。

1、环境需求

开发环境

Android Studio 2.1.3

最低支持

Android API 19

SDK 三方依赖

com.cmic.sso.sdk 、 com.unicom 、 cn.com.chinatelecom.account

网络环境

蜂窝数据(必须开启)或者蜂窝数据+wifi ，赋予网络权限

2、开发资源

SDK 当前版本

V2.3.3

SDK 当前版本更新内容

1.未勾选同意协议时的提示内容以及提示位置
2.未勾选协议时，点击一键登录，新增一个回调
3.修改已知 bug
3.授权页条款添加添加点击事件
4.添加设置条款勾选框状态方法
5.移动SDK升级-不再收集用户IMEI信息等不可变更的设备唯一标识

历史版本

详见历史版本

3、业务流程

您需要在APP中集成SDK，并在服务端完成API对接。全流程主要分为四个步骤：

第一步，初始化；

第二步，预取号；

第三步，拉取授权页；

第四步，一键登录授权；

第五步，服务端API置换号码(如下图)；

img1

二、集成开发

1、SDK资源包内容

·       JAR ：sai_sdk_xxx.jar;

·       JniLibs : libCtaApiLib.so(含：arm64-v8a,armeabi,armeabi-v7a,x86,x86_64);

·       res-umc : sdk所需资源文件及activity布局文件(anim, drawable, drawable-xxhdpi, layout, values文件);

·       layout:新增activity_oauth.xml、activity_oauth_ctc.xml，不可缺，v2.3.0新增；注意AndroidX与support包的区别

·       assets: uniaccount_classez.jar与 联通认证classes资源包，不可缺，v2.2.0新增；

·       assets:新增cucc/host_cucc.properties，增加联通通道，不可缺，v2.3.0新增；

2、Android Studio集成

.       将 *.jar 拷贝到工程的libs目录下，如没有该目录，可新建。

.       将sdk所需要的资源文件(anim, drawable, drawable-xxhdpi, layout, values文件)从demo工程 res-umc 目录下的文件添加到项目工程中。

.       将 jniLibs 拷贝到工程的main目录下。

.       将uniaccount_classez.jar包 和cucc/host_cucc.properties添加到 assets 目录下，如没有该目录，可在main目录下新建。

前四步的流程见集成流程图，如下：

img2

.       build.gradle文件下新增对应的配置，配置如下：

 

android {

 

....

 

// 配置res-umc 资源目录 

 

sourceSets {

 

main {

 

res.srcDirs = ['src/main/res', 'src/main/res-umc']

 

jni.srcDirs = []

 

jniLibs.srcDirs = ['src/main/jniLibs']

 

}

 

}

 

}

 

dependencies {

 

implementation files('libs/sai_sdk_xxx.jar')

 

}

.       AndroidManifest.xml 文件中添加对应的权限

 

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

 

<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"/>

对应权限对应的功能(缺一不可) ：

权限名

功能

INTERNET

网络权限

ACCESS_WIFI_STATE

获取wifi状态

ACCESS_NETWORK_STATE

获取手机网络状态

CHANGE_NETWORK_STATE

网络切换，wifi切换至蜂窝数据

.       配置授权登录activity

开发者根据需要配置横竖屏方向： android:screenOrientation 示列代码为 portrait(竖屏)
注意： v2.3.0版本新增OauthActivity、OauthActivityCtc，需要添加到AndroidManifest配置中。

 

<!-- 移动、电信、联通授权页面 --> 

 

<activity 

 

android:name="org.ox.base.OxLoginActivity" 

 

android:configChanges="orientation|keyboardHidden|screenSize" 

 

android:exported="false" 

 

android:launchMode="singleTop" 

 

android:theme="@style/umcsdk_dialog_style" />

 

<activity 

 

android:name="com.cmic.sso.sdk.activity.LoginAuthActivity" 

 

android:configChanges="orientation|keyboardHidden|screenSize" 

 

android:exported="false" 

 

android:launchMode="singleTop" 

 

android:theme="@style/umcsdk_dialog_style" />

 

<activity 

 

android:name="cn.com.chinatelecom.account.sdk.ui.AuthActivity" 

 

android:configChanges="orientation|keyboardHidden|screenSize" 

 

android:exported="false" 

 

android:launchMode="singleTop" 

 

android:theme="@style/umcsdk_dialog_style" />

 

<activity 

 

android:name="com.sdk.mobile.manager.login.cucc.OauthActivity" 

 

android:configChanges="orientation|keyboardHidden|screenSize" 

 

android:exported="false" 

 

android:launchMode="singleTop" 

 

android:theme="@style/umcsdk_dialog_style" />

 

<activity 

 

android:name="com.sdk.mobile.manager.login.ctc.OauthActivityCtc" 

 

android:configChanges="orientation|keyboardHidden|screenSize" 

 

android:exported="false" 

 

android:launchMode="singleTop" 

 

android:theme="@style/umcsdk_dialog_style" />

.       配置Android 9.0对Http的支持 ： 目前移动取号部分接口暂未支持https，需要配置http协议支持。

方式一 ： 在清单文件里配置以下代码：

 

android:usesCleartextTraffic="true"

方式二 ： 在资源文件新建xml目录，新建文件 network_security_config.xml， 在清单文件中配置

 

<?xml version="1.0" encoding="utf-8"?> 

 

<network-security-config>

 

<base-config cleartextTrafficPermitted="true" />

 

</network-security-config>

 

<!-- AndroidManifest.xml --> 

 

android:networkSecurityConfig="@xml/network_security_config"

.       添加混淆配置

 

# SAI SDK基本功能 

 

-dontwarn org.ox.**

 

-keep class org.ox.** { *; }

 

# 运营商SDK 移动 联通 电信 

 

-dontwarn com.cmic.**

 

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

 

-dontwarn com.unicom.**

 

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

 

-dontwarn cn.com.chinatelecom.**

 

-keep class cn.com.chinatelecom.** { *; }

 

-dontwarn com.sdk.**

 

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

注意：使用微信开源混淆工具的小伙伴，需要在build.gradle文件下额外配置相关的资源过滤规则(白名单)，否则会导致UI空白、闪退等问题。

 

andResGuard {

 

whiteList = [

 

"R.anim.umcsdk_**",

 

            "R.drawable.ct_account_brand_logo",

 

            "R.drawable.umcsdk_**",

 

            "R.layout.activity_oauth",

 

            "R.layout.activity_oauth_ctc",

 

            "R.layout.umcsdk_login_auth",

 

            "R.layout.umcsdk_login_auth_dialog",

 

            "R.layout.umcsdk_login_btn",

 

            "R.id.**",

 

            "R.string.**",

 

            "R.color.**",

 

            "R.style.**" 

 

]

 

}

参见：
build.gradle

三、一键登录

1、调用逻辑

a. 初始化SDK

b. 调用预取号(可省略-建议使用)

c. 调用一键登录(内部包含判断是否取号)-拉起授权页

d. 判断登录结果

e. 关闭授权页面

2、初始化

·       初始化SDK

方法描述

初始化SDK， 注意：请勿多次调用 ,V2.3.2版本可使用Application 进行初始化；建议使用Activity进行初始化

 

/**

 

* SDK初始化 请勿多次调用 

 

*

 

* @param context 上下文 

 

* @param param 参数 json 数据格式 

 

* @param pNotifier 回调对象 

 

* @return 大于等于0执行，结果回调。 以下几种请情况直接返回，不回调 

 

* 1：SDK已经初始化完成，无需多次初始化返回1,不回调;

 

* -45040：参数有误，缺失； 

 

* -45041：SDK正在初始化中； 

 

*/

 

public static int init(Context context, OxRequestParam param, OxNotifier pNotifier) {

 

......

 

}

代码示例

 

OxClientEntry.setDebugMode(true); // 开启debug 日志打印 

 

// https.http请求write/readTimeout，设置不小于3s;

 

// 调起SDK后整个执行过程的超时时间是timeout的2倍。 

 

/**

 

* TODO 默认5000 ms.单个请求也可在oxRequestParam 中设置'OxRequestParam.setTimeout(int)'

 

*/

 

OxClientEntry.setDefaultTimeout(4000);

 

JSONObject initParam = new JSONObject();

 

initParam.put("app_id", APP_ID);

 

initParam.put("app_secret", APP_SECRET);

 

OxRequestParam pInitParam = new OxRequestParam();

 

pInitParam.setActionType(OxActionType.INIT_SDK);

 

pInitParam.setStrData(initParam.toString());

 

pInitParam.setExtra(extraData);

 

return OxClientEntry.init(pInitContext, pInitParam, new MyNotifier());

参数说明

参数名称

参数类型

必填

描述

actionType

String

--

响应类型：
OxActionType.INIT_SDK

strData

app_id

String

是

官网注册获取的appId

app_secret

String

是

官网注册获取的appSecret

options

String

否

可选参数，JSON 格式

extra

Object

否

自定义参数，不参与请求。

响应信息

参数名称

参数类型

必填

描述

actionType

String

是

响应类型： OxActionType.INIT_SDK

strData

code

String

是

响应码 :“00000”成功

risk_code

String

否

风 风险码(可能存在多个)，通过账户进行配置才有返回 (V2.3.2新增)

risk_level

String

否

风险等级 (V2.3.2新增)

msg

String

否

响应信息

param

OxRequestParam

否

请求时的对象

返回strData实体示例 ：

 

{

 

"code":"00000",

 

"risk_code":"2013",

 

"risk_level":"3" 

 

}

3、预取号(可省略-建议使用)

·       预取号

方法描述

使用预取号后，可快速拉起授权页，需要开发者在 SDK 初始化完成 后 中的预取号操作 ， 如果不做 预取号操作 ，直接调用获取 登录 accessToken，会影响每次拉起授权页 的 等待时间。

 

OxClientEntry.requestAction(OxRequestParam);

代码示例

 

OxRequestParam param = new OxRequestParam();

 

param.setActionType(OxActionType.PRE_LOGIN);

 

int iResult = OxClientEntry.requestAction(param);

参数说明

参数名称

参数类型

必填

描述

actionType

String

是

请求类型：
OxActionType.PRE_LOGIN

strData

String

--

格式JSON

extra

Object

否

自定义参数，不参与请求。

响应信息

参数名称

参数类型

必填

描述

actionType

String

是

请求类型： OxActionType.PRE_LOGIN

strData

msg

String

是

响应消息

code

String

是

响应码 :“00000”成功

param

OxRequestParam

是

请求对象数据

返回strData实体示例 ：

 

{

 

"code":"00000", 

"msg":"success" 

 

}

4、拉起授权页

·       拉起授权页-一键登录

方法描述

即一键登录的主体功能

 

public static int requestAction(OxRequestParam param) {

 

......

 

}

代码示例

 

OxRequestParam param = new OxRequestParam();

 

param.setActionType(OxActionType.GET_ONEKEY_LOGIN_TOKEN);

 

int iResult = OxClientEntry.requestAction(param);

参数说明

参数名称

参数类型

必填

描述

actionType

String

是

请求类型：
OxActionType. GET_ONEKEY_LOGIN_TOKEN

strData

String

--

格式JSON

extra

Object

否

自定义参数，不参与请求。

响应信息

参数名称

参数类型

必填

描述

actionType

String

是

请求类型：OxActionType.GET_ONEKEY_LOGIN_TOKEN

strData

code

string

是

响应码 :“00000”成功

msg

string

否

响应信息

access_token

string

是

成功是返回access_token,用于从平台服务器获取手机号信息。获取用户信息API请查看服务端API文档。有效期为2分钟，

risk_code

string

否

风 风险码(可能存在多个)，通过账户进行配置才有返回 (V2.3.2新增)

risk_level

string

否

风险等级 (V2.3.2新增)

param

OxRequestParam

是

请求对象数据

返回strData实体示例 ：

 

 {

 

"access_token":"xx",

 

"code":"00000",

 

"risk_code":"2013",

 

"risk_level":"3" 

 

}

5、关闭授权页

·       关闭授权页

方法描述

用户完成登录后需手动调用结束授权页的方法

发布时间：2023-12-29
首页  ꄲ  服务与支持  ꄲ  一键登录接入指南
2022-09-05
企业发短信为什么更青睐第三方短信平台？
2022-08-26
短信平台哪个好？短信平台要如何选择？
2022-08-24
个性化短信之短信工资条：让HR解放双手，高效工作的神器！
2022-08-24
传统短信登录验证没落，一键登录迎来高光时刻？
2022-08-24
公告：对不符合国家法律法规的短信发送需求概不提供服务

推荐阅读

商务客服微信

ꄴ前一篇： 无
ꄲ后一篇： 无
넶浏览量：0