中移动一键登录开发指南androidv1.3

中国移动“和通行证”开发指南

中国移动“和通行证”面向客户端应用／插件提供用户认证服务。用户在终端设备上，一次认证即可自由登录所有业务。在插有中国移动SIM卡的终端上，中间件可以利用网络和SIM卡能力提供自动登录服务，登录过程对终端用户来说几乎无感知。

终端应用／插件可通过集成统一认证SDK调用中间件能力，减少开发者的开发难度。

目录

目录 ________________________________________________________________________ 2

1. 开发指南_________________________________________________________________ 3 1.1. 名词解释 _______________________________________________________________ 3

1.2. 开发前准备 _____________________________________________________________ 4 1.2.1. 申请开发者账号 ________________________________________________________ 4 1.2.2. 申请APPID ____________________________________________________________ 5

1.3. SDK集成步骤____________________________________________________________ 7 1.3.1. 新建工程并导入SDK的jar文件 __________________________________________ 8 1.3.

2. 配置AndroidManifest __________________________________________________ 11 1.

3.3. 使用步骤_____________________________________________________________ 12

2. API 说明________________________________________________________________ 13

2.1. SDK接口说明___________________________________________________________ 13 2.1.1. 显式登录接口 _________________________________________________________ 13 2.1.2. 隐式登录接口 _________________________________________ 错误！未定义书签。

2.1.

3. OAuth登录接口________________________________________ 错误！未定义书签。

2.1.4. 注销用户账号接口 _____________________________________________________ 15 2.1.5. 获取用户信息接口 _____________________________________________________ 15 2.1.6. 查询用户状态接口 _____________________________________________________ 17 2.1.7. 验证本机号码 _________________________________________________________ 18

2.2. SDK错误码说明_________________________________________________________ 23 2.2.1. 错误码详述___________________________________________________________ 23

修订记录

版本号日期编写审核摘要

V1.1 2015-01-0

8 李正1、[1.3.2]去掉配

置权限里面不必要的权

限

2、[2.2.2]获取用

户信息增加参考示例和

说明

3、增加[2.3] 常见

问题说明

2015-01-1 6 李正修改了AuthnHelper

实例化方式及接口调用

参数；

增加【2.1.6】接口

2015-01-2 6 李正修改接口的返回码

修改【2.1.5】接口

2015-02-1 3 李正增加两个接口：

1、查询用户状态接

口

2、查询用户话费余

额和流量

1.开发指南

本文档对使用SDK时所用的一些参数、方法进行说明，为开发者提供简单易用的API，并附有示例代码分析。

1.1.名词解释

名词说明

APP_ID 应用在中国移动统一认证平台申请的应用标识

APP_KEY 应用在中国移动统一认证平台申请的应用密钥

redirectUrl 应用在中国移动统一认证平台申请时填写的回调地址

AccessToken 第三方应用通过AuthCode换取的身份登录标识

AuthCode 第三方应用从统一认证平台获取的认证凭证，用于换取

AccessToken

隐式登录在静默登录过程中不显示程序登录授权界面

显示登录在静默登录过程中显示程序登录授权界面

1.2.开发前准备

1.2.1.申请开发者账号

1．申请帐号

在创建应用前，您需要成为一名中国移动社区的开发者。

进入移动开发者社区https://www.360docs.net/doc/5a13027194.html,，在首页面点击“注册”，进入开发者注册页面。如果是个人开发者，请选择“我要注册成为个人开发者”，如果是企业开发者，请选择“我要注册成为企业开发者”。

按照页面提示，填写注册信息，提交。成功提交后，即成为移动社区AP开发者。

2．填写合作资料

打开移动开发者社区https://www.360docs.net/doc/5a13027194.html,，在首页面输入帐户名、密码，点击“登陆”后进入自服务区。

首次登陆的开发者点击左侧菜单“合作资料申请/修改”菜单，填写合

作资料信息，如下图（以个人开发者为例），提交。

提交后，需等待合作管理员对合作资料进行初审，通过后可执行下述步骤。

1.2.2.申请APPID

1、进入社区－管理中心－申请能力应用页面，点击申请能力应用进入申请（如图）：

2、按提示填写应用名称、类型、系统平台、应用简介，勾选“统一认证”能力，点击提交即可生成APPID。查看APPID，请再点击“申请能力应用”页面查询已申请的应用信息即可（如图）：

3、该AppID可在开发过程中使用，请注意配置应用回调地址。

1.3.S DK集成步骤

总体使用流程：

1)集成后- 客户端获取accessToken

应用开发者直接调用SDK接口来获得Token；步骤如下：

1.构造SDK中认证工具类AuthnHelper的对象；

2.使用AuthnHelper中的getAccessToken方法，获得accessToken；

2)客户端通过accessToken获取用户信息

使用AuthnHelper中的getUserInfo方法，获得用户信息。

1.3.1.新建工程并导入SDK的jar文件

1、将UMCSDK_*.jar拷贝到应用工程的libs目录下，如没有该目录，可新建；在Project Explorer中右击鼠标，从弹出的菜单中，选中“Properties”;

在Properties窗口的左侧菜单项中，点击“Java Build Path”，并在右侧选中“Libraries”;

点击“Add JARs…”按钮，在弹出窗口中，选中jar文件，如下图1所示。

2、将sdk所需要的资源文件从res目录下的文件添加到项目工程中，如图：

drawable文件：

layout文件与value文件:

3、将中间件配置文件xml文件夹导入res目录下：如图

1.3.

2.配置AndroidManifest

注意：为避免出错，请直接从Demo中复制带标签的代码1、配置权限

2、配置授权登录activity

3、配置中间件账户管理服务

根据需要配置横竖屏方向

通过以上两个步骤，工程就已经配置完成了。接下来就可以在代码里使用统一认证的SDK进行开发了

1.3.3.使用步骤

1、AuthnHelper是SDK的功能入口，所有的接口调用都得通过AuthnHelper进

行调用。因此，调用SDK，首先需要创建一个AuthnHelper实例，其代码如下：init()方法最好在应用启动时调用

2、实现回调

所有的SDK接口调用，都会传入一个回调，用以接收SDK返回的调用结果。结果以JsonObjent的形式传递，TokenListener的实现示例代码如下：

3、接口调用

示例如下：

2.API 说明

2.1.S DK接口说明

2.1.1.登录接口

说明：登录接口分静默登录、显示登录、隐式登录、OAuth登录四个类型。会

根据用户调用登录接口传入的loginType进行判断。

静默登录：静默登录不会有界面弹出，也不要用户进行输入，能做到用户无感

知。静默登录会判断当前是否为移动卡，是则进行登录并返回登录信息，否则返

回非移动卡不能进行静默登录。

显示登录：自动判断当前最适合的登录方式；如果是移动卡会自动进行登录并且

显示一个授权activity，否则进入账号密码界面，让用户手动登录。并在接口中

返回登录相关信息。

隐式登录：自动判断当前最适合的登录方式；首次登录调用该认证方式时如果是

移动卡会自动进行登录并且显示一个授权activity，否则进入账号密码界面，让

用户手动登录。并在接口中返回登录相关信息，二次登录调用改认证方式时将不

会出现授权activity。

OAuth登录：短信验证码登录是让用户手动登录，手动输入电话号码，获取短

信验证码进行登录。并在接口中返回登录相关信息。

1、接口方法

public void umcLoginByType(final Context context, final String appId,final String appKey, final int loginType, final TokenListener listener)

2、参数说明

参数参数说明appid在开放平台申请能力应用的appID ，如：appKey在开放平台申请能力应用的appKey,如：

loginType 登录类型,包含四种登录类型:

1. AuthnHelper.UMC_LOGIN_DISPLAY 显示登录;

2. AuthnHelper. UMC_LOGIN_IMPLICIT_ 隐式登录;

3. AuthnHelper.UMC_LOGIN_SILENT 静默登录;

4. AuthnHelper.UMC_LOGIN_OAUTH 短信验证码登录。

listener回调接口，TokenListener实例。context Activity 实例

3、示例代码

代码示例，代码中的mListener是T okenListener的一个实例

1.静默登录示例代码

2.显示登录示例代码

3.隐式登录示例代码

4.OAuth登录示例代码

4、返回参数说明：

参数名称类型必需说明

resultcode String Y 接口返回码，全部返回码见附录【2.2】;”000”成功resultdesc String Y 返回码说明

uniqueid String Y用户身份的标识

passId String Y通行证号

expiresIn String Y过期时间，如90（天）

accessToken String Y身份标识，字符串形式的token，第三方应用将该凭

证经应用平台向IDMP平台请求认证

2.1.2.注销用户账号接口

说明：该接口会清除用户保存在本地的账号信息，包括AccessToken等信息。

1、接口方法

public boolean logOut()

2、示例代码

2.1.

3.获取用户信息接口

说明：该接口是登录成功后，通过accessToken等参数获取用户信息，如需获取

手机号码和邮箱地址需要在申请APPID时申请高级应用权限。

1、接口方法

public void getUserInfo(String appid, String accessToken, String uniqueId,TokenListener listener)

2、参数说明

参数参数说明

appid在开放平台申请能力应用的appID，如：

accessToken身份标识，字符串形式的token，第三方应用将该凭证经应用平台向IDMP平台请求认证，登录接口返回的参数

listener 回调接口，TokenListener实例。

uniqueId 用户身份的标识，登录接口返回的参数

3、示例代码

4、返回参数说明：

说明

参数名称类型必

需

resultcode String Y 接口返回码，根据实际情况在每对消息中自

行义

处理状态编码

401000：未知错误。

401001：成功查询到用户信息。

401002：用户ID不存在

401006：系统流量限制

401007：同一用户查询过于频繁

401008：系统错误

7002：参数错误

SVC0906：请求格式错误

其它参考【2.2】错误码说明

resultdesc String Y 返回码说明

userid String N统一认证用户身份凭证

nickName String N用户昵称

province String N用户所属省份

regioncode String N手机号码对应的地区编码（与Boss的编码表保持一

致）

andid String N 扩展字段

resultMessage String N 结果信息说明

uniqueId String N 开放平台用户身份的标识

msisdn String N 手机号码（需要高级权限）

email String N 邮箱地址（需要高级权限）

2.1.4.查询用户状态接口

说明：该接口是登录成功后，通过accessToken等参数获取用户状态等信息，此

接口需要在申请APPID时申请高级应用权限

1、接口方法

public void getStatusByMobileNumber(String appid, String accessToken, String uniqueId,TokenListener listener)

2、参数说明

参数参数说明

appid在开放平台申请能力应用的appID，如：

accessToken身份标识，字符串形式的token，第三方应用将该凭证经应用平台向IDMP平台请求认证，登录接口返回的参数

listener 回调接口，TokenListener实例。

uniqueId 用户身份的标识，登录接口返回的参数

3、示例代码

4、返回参数说明：

说明

参数名称类型必

需

resultcode String Y 接口返回码，根据实际情况在每对消息中自

行义

处理状态编码

103280：查询用户状态成功。

103281：用户不存在。

103282：手机号格式有误。

103283：系统错误

7002：参数错误

SVC0906：请求格式错误

其它参考【2.2】错误码说明

resultdesc String Y 返回码说明

card_type String N 用户手机品牌0-未知1-全球通2-动感地带3-神州

行4-大众卡

prov_code String N 省份代码

area_code String N 地区代码

status String N 用户状态：

0：正常，其他都为不正常状态

状态

0：正常

1：停机

2：预销号

3：销号

2.1.5.验证本机号码

说明：应用将手机号码传给统一认证SDK，统一认证SDK向统一认证服务端发

起本机号码校验请求，统一认证服务端通过网关或者短信上行获取本机手机号码

和第三方应用传输的手机号码进行校验，返回校验结果。

1、接口方法

public void silentVerifyMobile(Context context, String appid, String appKey, String mobile, final TokenListener listener) 2、参数说明

参数参数说明

context Activity 实例

appid在开放平台申请能力应用的appID，如：

appKey在开放平台申请能力应用的appKey,如：

mobile 需要验证的手机号码

listener 回调接口，TokenListener实例。

3、示例代码

mHelper.silentVerifyMobile(mContext,Constant.APP_ID, Constant.APP_KEY, mobile, new TokenListener() {

public void onGetTokenComplete(JSONObject jsonobj) {

//回调数据处理

}

});

4、返回参数说明：

说明

参数名称类型必

需

resultcode String Y 接口返回码，参考【2.2】错误码说明

desc String Y 返回码说明

rnd String N 随机数

isLocalMobile boolean N 是否本机号码

true 是false 否

2.2.平台接口说明

2.2.1.获取用户信息

接口描述

应用在获得用户的AccessToken后，用AccessToken去换取用户的身份信息，请参考示例2.2.3，注意不要有参数直接空格，超时时间设为30秒平台对外可用环境地址如下：

https://https://www.360docs.net/doc/5a13027194.html,:443/omp/2.0/idmp/getUserInfo

接口方向

接口提供方接口调用方

开放平台三方平台

参数说明

参数名称约束参数类型说明clientId 必选string 用户在开放平台申请的appid accessToken 必选string 用户通过sdk获取的accessToken uniqueId 必选string 用户通过sdk获取的uniqueId,用于

唯一标识apptype 必选string web应用:0 终端应用:1

响应

参数名称类型必

说明

需

resultcode String Y 接口返回码，根据实际情况在每对消息中自

行义

处理状态编码

401000：未知错误。

401001：成功查询到用户信息。

401002：用户ID不存在

401006：系统流量限制

401007：同一用户查询过于频繁

401008：系统错误

7002：参数错误

SVC0906：请求格式错误

其它参考【2.2】错误码说明

resultdesc String Y 返回码说明

userid String N 统一认证用户身份凭证nickName String N 用户昵称

province String N 用户所属省份

regioncode String N 手机号码对应的地区编码（与Boss的编码表

保持一致）