Mobile IS AAAClientAPI接口说明文档11.docx

Mobile IS AAAClientAPI接口说明文档11.docx

《Mobile IS AAAClientAPI接口说明文档11.docx》由会员分享，可在线阅读，更多相关《Mobile IS AAAClientAPI接口说明文档11.docx（46页珍藏版）》请在冰点文库上搜索。

MobileISAAAClientAPI接口说明文档11

UserGuideDocument

<>

Author-<>

RevisionNo–0.1

IssueDate-<<2010-11-03>>

DOCUMENTPDSID:

PRODUCT:

MobileIS

RELEASE:

FEATURE:

AAAOAuthClientAPI（JavaScript/Javaversion）

SUBSYSTEM:

KEYWORDS:

Keywords:

⏹MobileIS

RevisionHistory

Revision#

Author

ReviewedBy

A.DescriptionOfChange

B.SummaryofReview

Issuedby/Date

1.0

Cherry.Zeng

Createthedocument

2010-11-03

1.1

Cherry.Zeng

Roc.Yang

UpdategetGuestAuthToken&getUserAuthTokeninterfacedescription

2010-11-05

UTStarcomProprietary

NotforuseordisclosureoutsideUTStarcom,Inc.oranyofitssubsidiaries

Exceptunderpriorwrittenagreement.

OtherIntendedAudience:

QualityAssuranceGroup&InternalAuditors.

Thisdocumentiscontrolledelectronicallyandanyhardcopyshouldbeconsidereduncontrolled.

ThelatestversionofthisdocumentmaybeobtainedfromthePDSID-UTSI-ENG-2007xxxx.

Thisdocumentisownedby<>.

TABLEOFCONTENTS

UserGuideDocument1

1Introduction4

1.1PurposeandScope4

2AuthenticationAndAuthorizationFlow4

2.1End-Userauthenticationandauthorizationflow4

2.2Userauthorizedtoaccessresourcesflow4

3AAAOAuthClientAPIinterfacedefinition5

3.1.1GetRequestToken【RequestToken/RequestApplicationAuthentication】6

3.1.2GetAuthorizedToken【RequestAuthorizedToken】6

3.1.3GetGuestAuthenticatedToken【RequestGuestAuthenticatedToken】8

3.1.4GetAccessToken【RequestServiceAccessToken】8

3.1.5VerifyAccessToken【VerifyToken】9

4AAAJavaScriptClientAPI使用说明10

4.1使用方法10

4.1.1引入（include）JS文件10

4.1.2在应用/业务的页面创建相应的DIV10

4.1.3接口调用方法（类似C）10

3.1.3.1调用API方法一：

分步执行10

3.1.3.2调用API方法一：

一步执行11

3.1.4接口调用方法（类似C++的）12

3.1.4.1调用API方法一：

分步执行12

3.1.4.2调用API方法二：

一步执行13

4.2Sample说明14

Appendix :

JSClientAPI联调测试情况17

（1）PCTest17

（2）MobileTest18

（3）目录文件20

（4）测试数据21

5AAAJavaClientAPI使用说明21

5.1使用方法21

5.1.1初始化全局变量参数21

5.1.2使用示例文件Test.java说明21

5.1.3JavaClientAPI接口及源码说明23

5.2OrganizationofOauthClientsourcecode26

5.3Compile28

5.4Run28

5.5开发测试环境与测试数据29

1Introduction

1.1PurposeandScope

GivetheinterfacedefinitiondescriptionforAAAOauthClientAPI,andtheguidencefortheuserswhowilluseOAuthprotocoltodeveloprelatedmodulesandinter-debugthemodulesbyusingthisOAuthClient.ThisClientisdevelopedbyJavaScript/Javaprogramminglanguage.

2AuthenticationAndAuthorizationFlow

2.1End-Userauthenticationandauthorizationflow

2.2Userauthorizedtoaccessresourcesflow

3AAAOAuthClientAPIinterfacedefinition

3.1.1GetRequestToken【RequestToken/RequestApplicationAuthentication】

Description

RequestUnauthorizedToken/RequestApplicationAuthentication就是应用的认证。

即应用请求获取未授权的Token。

接口时序

N/A

接口协议内容

接口描述：

本接口在用户通过SDP请求登录，AAA平台将未授权的RequestToken返回给SDP服务系统。

承载协议：

http

接口方向：

SDP（ServiceDeliveryPlatform）–〉AAA

接口地址：

//accounts/OAuthGetRequestToken

接口功能：

获取未授权的RequestToken

备注说明：

只支持header中传递参数

OAuthGetRequestTokenAuthorizationHeader包含如下信息：

名称

说明

数据

类型

长度

是否

必选

End_Platform

标识AAAClient（Application）或者终端平台属性

目前可能的值为：

PC,TV,ME/Mobile;不区分大小写

String

M

Oauth_Consumer_key

TheConsumerKey，通过注册申请Chapter5.2

String

M

Oauth_Signature_method

签名方法HMAC-SHA1,RSA-SHA1,andPLAINTEXT,目前仅支持HMAC-SHA1

String

M

Oauth_Signature

签名值,如HMAC-SHA1=（key_secret,base_string）

String

160

M

Oauth_Timestamp

时间戳，thenumberofsecondssinceJanuary1,197000:

00:

00GMT

String

M

Oauth_Nonce

Arandomstring,uniquelygeneratedforeachrequest.md5（oauth_consumer_key,oauth_timestamp+rand（））

String

M

Oauth_Version

（optional）TheOAuthversionusedbytherequestingapplication.Thisvaluemustbe"1.0"

String

O

接口应答消息UnauthorizedRequestTokenResponse包含如下信息：

名称

说明

数据类型

长度

是否

必选

Oauth_Token

未授权的RequestToken

String

M

Oauth_Token_secret

对应的RequestTokenSecret

String

M

3.1.2GetAuthorizedToken【RequestAuthorizedToken】

描述：

请求用户授权Token，即用户授权。

该接口包含两个阶段的消息交互：

SDP<->UMS<->AAA

1）SDP发送请求到UMS，验证用户信息；

2）UMS完成用户信息验证后发送OAuthGetAuthToken请求到AAA，获取用户AuthToken

3）UMS拿到AuthToken后，返回AuthToken,UserID给SDP

GetUserAuthToken:

SDP<->UMS

接口描述：

SDP发送请求到UMS，验证用户信息,得到UMS返回的AuthToken和UserID

承载协议：

http

接口方向：

SDP–〉UMS

接口地址：

接口功能：

获取授权的AuthToken

备注说明：

该接口JavaScript和Java版本有所区别：

请求消息中，Java版是在URI中带上传递的参数，JS版是在Body中以JSON格式传递参数

OAuthGetUserAuthorizeToken包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

Oauth_Token

上一步中获得的RequestToken

String

M

Oauth_Token_secret

对应的RequestTokenSecret

String

M

User_name

用户注册的用户名

String

M

Password

用户密码

String

M

接口应答消息包含如下信息：

名称

说明

数据类型

长度

是否必选

Oauth_Token

授权的AuthToken

String

M

Oauth_Token_Verifier

对应的AuthTokenSecret

String

M

User_ID

用户ID

String

M

GetAuthToken:

UMS<->AAA

接口描述：

本接口在用户通过SDP请求登录，AAA平台将授权的Token返回给SDP服务系统。

承载协议：

http

接口方向：

UMS–〉AAA

接口地址：

//accounts/OAuthAuthorizeToken

接口功能：

获取授权的AuthToken

备注说明：

（FromUMS）

OAuthGetAuthorizeToken包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

Oauth_Token

上一步中获得的RequestToken

String

M

Oauth_Token_secret

对应的RequestTokenSecret

String

M

User_Name

用户注册的用户名

String

M

IsAuthenticated

1or0（OnlyforUMS）

String

M

接口应答消息包含如下信息：

名称

说明

数据类型

长度

是否必选

Oauth_Token

用户授权的AuthToken

String

M

Oauth_Token_Verifier

对应的TokenSecret

String

M

3.1.3GetGuestAuthenticatedToken【RequestGuestAuthenticatedToken】

Description

请求Guest用户授权Token，即Guest用户授权。

接口时序

N/A

接口协议内容

接口描述：

本接口在guest用户通过SDP请求登录，AAA平台将AuthToken返回给SDP服务系统。

承载协议：

http

接口方向：

SDP（ServiceDeliveryPlatform）–〉AAA

接口地址：

//accounts/OAuthGetAuthToken

接口功能：

获取授权的AuthToken

备注说明：

OAuthGetGuestAuthToken包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

End_Platform

标识AAAClient（Application）或者终端平台属性

目前可能的值为：

PC,TV,ME/Mobile;不区分大小写

String

M

Oauth_Consumer_key

TheConsumerKey，通过注册申请

String

M

Oauth_Token

上步获得的Token

String

M

Oauth_Verifier

认证的token的校验值

String

160

M

User_name

Value:

guest

Oauth_Timestamp

时间戳，thenumberofsecondssinceJanuary1,197000:

00:

00GMT

String

M

Oauth_Version

（optional）TheOAuthversionusedbytherequestingapplication.Thisvaluemustbe"1.0"

String

O

接口应答消息包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

Oauth_Token

授权的AuthToken

String

M

Oauth_Token_verifier

对应的AuthTokenSecret

String

M

3.1.4GetAccessToken【RequestServiceAccessToken】

Description

SDP向AAA平台首先请求AccessToken,作为后续请求访问业务的Token。

接口时序

N/A

接口协议内容

接口描述：

本接口在用户通过SDP请求登录，AAA平台将AccessToken返回给SDP服务系统。

承载协议：

http

接口方向：

SDP（ServiceDeliveryPlatform）–〉AAA

接口地址：

//accounts/OAuthGetAccessToken

接口功能：

获取AccessToken

备注说明：

名称

说明

数据类型

长度（字节）

是否必选

End_Platform

标识AAAClient（Application）或者终端平台属性

目前可能的值为：

PC,TV,ME/Mobile;不区分大小写

String

M

Oauth_Consumer_key

TheConsumerKey，通过注册申请

String

M

Oauth_Token

上步获得的Token

String

M

Oauth_Verifier

认证的token的校验值

String

M

Resource_ID

访问的资源ID

String

M

Oauth_Timestamp

时间戳，thenumberofsecondssinceJanuary1,197000:

00:

00GMT

String

M

Oauth_Version

（optional）TheOAuthversionusedbytherequestingapplication.Thisvaluemustbe"1.0"

String

O

OAuthGetAccessToken包含如下信息：

接口应答消息包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

Oauth_Token

AccessToken

String

M

Oauth_Token_secret

对应的AccessTokenSecret

String

M

3.1.5VerifyAccessToken【VerifyToken】

Description

资源服务器收到应用的访问请求（带AccessToken等相关信息）后，首次需要到AAA验证此Token的有效性。

接口时序

N/A

接口协议内容

接口描述：

资源服务器收到应用的访问请求（带AccessToken等相关信息）后，首次需要到AAA验证此Token的有效性。

承载协议：

http

接口方向：

ResourceServer–〉AAA

接口地址：

//accounts/OAuthVerifyToken

接口功能：

AccessToken有效性验证

备注说明：

VerifyAccessToken包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

consumer_key

访问资源的应用

String

M

User_ID

授权的用户ID（从getUserAuthTokenrsp中获取）

String

M

Oauth_Token

获得的AccessToken

String

M

Oauth_Verifier

认证的token的校验值

String

M

接口应答消息包含如下信息：

名称

说明

数据类型

长度（字节）

是否必选

httpstatuscode

4AAAJavaScriptClientAPI使用说明

4.1使用方法

4.1.1引入（include）JS文件

src="

src="

src="">

4.1.2在应用/业务的页面创建相应的DIV

例如：

none">