一键登录文档

修订历史

目录

1. 能力申请

注意事项：

1.认证取号服务必须打开蜂窝数据流量，并且应用应有蜂窝数据权限；

2.取号请求过程需要消耗用户少量数据流量（国外漫游时可能会产生额外的费用）；

3.使用WiFi网络不会影响一键登录功能。

1.1 接入流程

1. 申请appid和appkey

根据《开发者接入流程文档》，联系易讯云商务人员按照文档要求创建开发者账号并申请appid和appkey，并提交应用名称、简介、类型、应用图标（256X256）、公钥1024bit pkcs#8格式）、调用“一键免密登录”能力 IP地址；安卓应用另提交登录页面类名、应用包名、应用签名，iOS应用另提交ios bundle ID。

2. 申请能力

应用创建完成后，联系易讯云商务人员申请开通“一键免密登录”能力。

2. Android开发流程

说明

Android sdk支持版本：Android4.0以上

本文档为一键登录SDK1.1版本开发文档

2.1 下载SDK及相关文档

请在易讯云官网下载最新的SDK集合包

www.51yixun.com

2.2 搭建开发环境

1. 建立你的工程。

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

3. 在build.gradle中添加依赖。

​x
ndk {
       abiFilters "armeabi"
     }
​
​
repositories {
    flatDir {
        dirs 'libs'
    }
}
dependencies {
//okHttp框架
 implementation 'com.squareup.okhttp3:okhttp:3.12.0'
 //添加易讯云一键登录sdk
 //Android 添加
 implementation name: 'YxAccountSdk-release-2.0.0', ext: 'aar'
 //Androidx 添加
 implementation name: 'YxAccountSdkx-release-2.0.0', ext: 'aar'
 
 //移动api
 implementation name: 'CMCCSSOSDK-release', ext: 'aar'
 //电信api
 implementation name: 'CTAccountSdk_HY_v3.7.0_armeabi', ext: 'aar'
}

4. 添加必要的权限

AndroidManifest.xml设置

xxxxxxxxxx
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<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" />

权限说明：

2.3 开始开发

1. 创建一个YxAuthnHelper实例

YxAuthnHelper是SDK的功能入口，所有的接口调用都得通过YxAuthnHelper进行调用。因此，调用SDK，首先需要创建一个YxAuthnHelper实例

方法原型：

xxxxxxxxxx
public static YxAuthHelper getInstance(Context context)

参数说明：

示例代码：

xxxxxxxxxx
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mContext = this;
……
mAuthHelper = YxAuthHelper.getInstance(mContext);
}

2. 初始化 APPID

设置 APPID 和 appSecret

方法原型：

xxxxxxxxxx
 public void init(String appId, String appSecret) 

参数说明：

3. 初始化

可以通过initNet方法设置SDK的请求超时时间，默认10s，设置以ms为单位。

方法原型：

xxxxxxxxxx
public static void initNet(int connectTimeout, int readTimeout, int writeTimeout )

参数说明：

4. 设置主题

开发者可根据开放接口，对授权页进行定制

方法原型：

xxxxxxxxxx
YxAuthPageConfig yxAuthPageConfig = new YxAuthPageConfig.Builder(context)
                                    /**
                                    自定义配置
                                    ***/
                                    .build()
​
public void setYxAuthPageConfig(YxAuthPageConfig yxAuthPageConfig) 

5.验证码功能

短信验证码功能在特殊网络环境下，当一键登录获取手机号失败时，提供补充登录功能。开发者可选择是否启用短信验证码功能，默认false。

xxxxxxxxxx
public void setSmsLogin(boolean smsLogin)

6. 实现回调

所有的SDK接口调用，都会传入一个回调，用于接收SDK返回的调用结果。结果以 Json字符串的形式传递，

ResultListener的实现示例代码如下：

xxxxxxxxxx
mListener = new ResultListener() {
@Override
public void onResult(String result) {
……
}
};

短信验证码登录界面回调：

xxxxxxxxxx
smsLoginListener = new SmsLoginListener() {
            @Override
            public void getCode(String result) {
                //获取短信验证码回调
            }
​
            @Override
            public void getToken(String result) {
                //获取token（即登录）回调
            }
        });

短信验证码回调 result 参数说明：

2.4 一键登录功能

1． 预取号请求

使用 SDK 登录前，需要提前调用预登录接口，完成网络判断、蜂窝数据网络切换等操作，获取预登录结果、运营商类型等信息。

取号方法原型：

xxxxxxxxxx
public void preLogin(ResultListener resultListener)

参数说明：

响应参数:

onResult的参数result为json字符串，含义如下。

示例代码：

xxxxxxxxxx
//创建YxAuthnHelper实例
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mContext = this;
/***
判断和获取READ_PHONE_STATE权限逻辑
***/
​
mAuthnHelper = YxAuthnHelper.getInstance(mContext);
    //实现取号回调
mListener = new ResultListener() {
@Override
public void onResult(String result) {
……// 应用接收到回调后的处理逻辑
}
       };
​
//调用取号方法
mAuthnHelper.preLogin(mListener);
}

2. 授权请求

应用调用本方法时，SDK将拉起用户授权页面，用户确认授权后，SDK将返回token给应用客户端。

授权请求方法原型：

xxxxxxxxxx
//创建YxAuthnHelper实例
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mContext = this;
/***
判断和获取READ_PHONE_STATE权限逻辑
***/
​
mAuthnHelper = YxAuthnHelper.getInstance(mContext);
    //实现回调
mListener = new ResultListener() {
@Override
public void onResult(String result) {
……// 应用接收到回调后的处理逻辑
}
       };
​
//
mAuthnHelper.login(mListener);
}

请求参数:

响应参数:

onResult的参数result为json字符串，含义如下：

示例代码：

xxxxxxxxxx
//创建YxAuthnHelper实例
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
mContext = this;
/***
判断和获取READ_PHONE_STATE权限逻辑
***/
​
mAuthnHelper = YxAuthnHelper.getInstance(mContext);
    //实现回调
mListener = new ResultListener() {
@Override
public void onResult(String result) {
……// 应用接收到回调后的处理逻辑
}
       };
​
​
mAuthnHelper.login(mListener);
}

2.5 授权页设计

1. 移动授权页设计

使用new YxAuthPageConfig.Build().setCmXXX()设置移动授权页中对应的元素。

2. 联通授权页设计

使用new YxAuthPageConfig.Build().setCuXXX()设置移动授权页中对应的元素。

3. 电信授权页设计

使用new YxAuthPageConfig.Build().setCtXXX()设置移动授权页中对应的元素。

4.验证码登录页面设计

使用new YxAuthPageConfig.Build().setSmsXXX()设置验证码登录页中对应的元素。

3. iOS开发流程

3.1 下载SDK及相关文档

请在易讯云官网下载最新的SDK集合包

xxxxxxxxxx
www.51yixun.com

3.2 导入 SDK

按实际情况导入debug 或者 release，以及相应的bundle文件。该 SDK 需要依赖第三方库 AFNetworking，Masonry请自行导入。

3.3 编译设置

1. 配置ATS

在 info.plist 文件中添加 App Transport Security Settings 项，并在其中添加 Allow Arbitrary Loads 子项，同时将该子项的值设置为 YES

2. 添加依赖字段

（1）在BuildSetting-Hearder Search Paths 中设置 EAccountHYSDK.framework 文件的路径，并将右边的值设置为 recursive

（2）在BuildSetting-Other Linker Flags 中添加“-ObjC”、“-lstdc++”和“-force_load”加上EAccountHYSDK.framework/EAccountHYSDK 所在的路径（路径注意带双引号，比如""$(SRCROOT)/EAccountHYSDK.framework/EAccountHYSDK"）。

3. 添加依赖库

在项目设置 target -> Build Phases->Link Binary with Libraries 下添加 libc++.1.tbd 和 libz.1.2.8.tbd。

3.4 SDK 的使用

1.在 APPDelegate 引入头文件

xxxxxxxxxx
   #import   <YxAuthHelperSDK/YxAuthHelper.h>

2、初始化

在 didfinsh 方法中，传入申请的 appid 和 appsecret 调用接口进行初始化及预登录。

方法原型：

xxxxxxxxxx
- (void)requestPreLogInWithAppIdServer:(NSString *)appId appSecretServer:(NSString *)appSecret completion:(TypeCompletionSucess)typeCompletionSucess failure:(TypeCompletionFailure)typeCompletionFaiure;

成功响应：

响应参数为 NSDictionary *result，包含内容如下：

失败响应：

响应参数为 NSError *error

3、获取token

在开发需要的地方调用以下接口获取 SIM 卡运营商返回的 Token，需要传入当前的controller。

短信验证码能在特殊网路环境下，一键登录失败时，提供补充登录功能。使用 SMSmode 设置是否选择短信验证码登录功能。

方法原型：

xxxxxxxxxx
​
- (void)getLogInTokenWithController:(id)viewController SMSmode:(BOOL)mode Completion:( TokenCompletionSucess)tokenCompletionSucess failure:(TokenCompletionFailure)tokenCompletionFailure;
​

响应参数：

响应参数为 NSDictionary *tokenResponse，包含内容如下：

失败响应：

失败响应参数为：NSError *error

4、自定义授权页

使用YxAuthHelper 的 customUAModelBlock 和 cuAuthVCBlock 以及修改nib的方法来实现自定义授权页。

移动和联通的授权页使用block来设置；电信的通过修改EAccountOpenPageResource中的EAccountAuthVC.xib,然后用生成的EAccountAuthVC.nib文件将原来的EAccountAuthVC.nib替换，生成方法可以参考开发包中的“生成nib文件的方法.doc”

4． 平台接口

4.1获取用户信息接口

1.接口说明

请求地址：

xxxxxxxxxx
https://x.91yixun.com/auth/getUserInfo

协议：

HTTPS

请求方法：

POST

注意：开发者需到正确填报服务端出口IP地址后才能正常使用

2.参数说明

请求参数:

响应参数:

4.2 相关源码

相关源码请在易讯云官网下载。

xxxxxxxxxx
 www.51yixun.com

5. SDK常见错误码定义

5.1 SDK错误码定义

5.2 移动错误定义

5.3 联通错误定义

5.4 电信错误定义

Android 自定义错误码

iOS 自定义错误码