ICS33.030
中华人民共和国通信行业标准
YD/T3190—2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(APD)移动互联网用户上下文感知业务
RESTfulbased ServiceCapabilityOpenAPIUserContentPerception of MobileInternet2016-10-22发布
中华人民共和国工业和信息化部2017-01-01实施
2规范性引用文件
3术语、定义和缩略语.
3.1术语和定义
3.2缩略语.
4移动互联网用户上下文感知业务API定义4.1
业务概述,
资源概述.
数据结构定义
4.4流程图.
5资源详细规范.
资源:用户上网信息
5.2资源:用户上网方式
资源:是否通过蜂窝数据上网
5.4资源:用户身份鉴权信息
5.5资源:用户手机号码,
5.6资源:用户伪码信息.
6安全要求..
6.1认证鉴权.
6.2用户隐私保护
附录A(规范性附录)响应码要求参考文献,
YD/T3190—2016
YD/T3190—2016
《移动互联网用户上下文感知平台技术要求》和《基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)移动互联网用户上下文感知业务》共同构成支撑“移动互联网用户上下文感知业务”的系列标准。
本标准是“基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)”系列标准之一一,该系列标准的结构及名称预计如下:一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)消息业务;
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)据业务;
一基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)上下文感知业务。
本标准按照GB/T1.1-2009给出的规则起草。短消息和多媒体
点击拨号;
终端状态;
终端能力信息;
微博业务;
搜索业务:
地址本:
文件传输业务;
定位业务;
状态呈现业务;
聊天业务;
用户信息业务:
支付业务:
视频共享;
图片共享;
非结构化补充数
移动互联网用户
请注意本文件的某些内容可能涉及专利。本文件的发布机构不承担识别这些专利的责任。本标准由中国通信标准化协会提出并归口。本标准起草单位:中国联合网络通信集团有限公司、中国电信集团公司、中国信息通信研究院、中兴通讯股份有限公司。
本标准主要起草人:廖慧、李娜、张鹏、罗云彬、王蓉、王志军、郑明。I
YD/T3190—2016
基于表述性状态转移(REST)技术的业务能力开放应用程序接口(API)移动互联网用户上下文感知业务1范围
bzxz.net本标准规定了基于表述性状态转移(REST)技术的移动互联网用户上下文感知业务能力开放应用程序接口(API),包括接口数据结构、接口定义和安全要求等。本标准适用于提供移动互联网用户上下文感知业务能力开放的应用程序接口(API)。2规范性引用文件
下列文件对于本文件的应用是必不可少的。凡是注日期的引用文件,仅所注日期的版本适用于本文件。凡是不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。移动互联网用户上下文感知平台技术要求IETFRFC2616超文本传送协议--HTTP/1.1(HypertextTransferProtocol--HTTP/1.1)OMA-TS-RESTNetAPICommonRESTful风格的网络API通用定义(CommondefinitionsforRESTfulNetwork)
3术语、定义和缩略语
3.1术语和定义
下列术语和定义适用于本文件。3.1.1
表述性状态转移RepresentationalStateTransfer一种针对网络应用的设计和开发方式,指的是一组架构约束条件和原则,可以降低开发的复杂性,提高系统的可伸缩性。
移动互联网用户上下文感知平台UserContentPerceptionPlatformofMobileInternet一种通过并联方式在通用的分组域设备上进行流量分光后,进行分析跟踪特定的HTTP数据包和手机号码的对应关系及其他上下文信息,并由服务端通过安全连接来查询此对应关系的平台,主要实现终端手机号码的识别,及终端手机号码和其他上下文信息的传送。1
YD/T3190—2016
移动互联网用户上下文感知信息UserContentPerceptionInformationofMobileInternet移动互联网用户上下文感知平台所生成的信息。《移动互联网用户上下文感知平台技术要求》。3.2缩略语
下列缩略语适用于本文件。
CELLID
MSISDN
ApplicationProgrammingInterfaceCell Id
HyperText Transfer Protocol
HypertextMarkupLanguage
InternationalMobileSubscriberIdentityInternationalMobileEquipmentIdentityInternetProtocol
JavaScript Object Notation
Location Area Code
MobileSubscriberInternationalISDN/PSTNnumberRepresentational State TransferUniformResourceIdentifier
UniformResourceLocator
eXtensibleMarkupLanguage
4移动互联网用户上下文感知业务API定义4.1业务概述
应用程序编程接口
小区编码
超文本传输协议
超文本标记语言
国际移动用户识别码
国际移动设备身份码
因特网协议
JavaScript对象标记
位置区编码
移动用户号码
表述性状态转移
统一资源标识
统一资源定位符
扩展标记语言
移动互联网用户上下文感知业务,是由移动互联网用户上下文感知平台提供的一种业务,平台通过通过并联方式在通用的分组域设备上进行流量分光后,进行分析跟踪特定的HTTP数据包和手机号码的对应关系及其他上下文信息,并由服务端通过安全连接来查询此对应关系实现终端手机号码的识别,及终端手机号码和其他上下文信息的传送。其中,移动互联网用户上下文感知业务中主要提供的上下文信息包含以下几个:用户上网信息:包括用户手机号码、用户伪码信息、IMEI、IMSI、LAC、Cellid;一用户上网方式:包括接入的网络类型和接入方式建;用户是否通过蜂窝数据上网;
一用户身份鉴权信息:第三方提供鉴权参数和用户号码,可以提供用户身份鉴权提供服务,即鉴权结果(YESorNO);
用户手机号码;
用户伪码信息。
4.2资源概述
本节概要描述了移动互联网用户上下文感知业务的RESTfulAPI所用到的资源。YD/T3190—2016
本标准中URL变量“apiVersion”的取值为“v1”表明该API对应于本标准。URL变量“apiVersion”的语义定义见OMA-TS-RESTNetAPI_Common。图1为移动互联网用户上下文感知业务的RESTfulAPI的资源树结构。注:资源树中实线框所示的节点表示该节点有关联的HTTP方法,(serverRoot)
/userContentPerception/apiVersion)userContentinfo
/userinternetMode
fisUsingCeltutarData
userldentityAuthentication
MSISDNO
userCode
uniqueValueO
TuniqueValue
LuniqueValueO
funiqueValue
uniqueValue
uniqueValue
图1本标准中定义的资源结构
MSISDN
表1给出了本标准中定义的资源的详细说明、代表的数据类型以及允许的HTTP方法。其中,数据类型均采用W3CXMLSchema定义。表1资源定义
用户上网
用户上网
是否通过
蜂窝数据
用户身份
鉴权信息
用户手机
用户伪码
基础URL:http://(serverRoot)/userContentPerception/(apiVersion)/userContentInfo
/userInternetMode
/isUsingCellularData
/userldentityAuthentication
/MSISDN
luserCode
数据结构
UserContentInfo
(usedforGET)
UserIntermetMode
(usedforGET)
isUsingCellularData
(usedforGET)
Userldentity
Authentication
(usedforGET)
MSISDN
(usedforGET)
UserCode
(usedforGET)
HTTP方法
返回用户上网
返回用户上网
返回用户是否
通过蜂窝数据
返回用户身份
鉴权结果信息
返回用户手机
返回用户伪码
DELETE
YD/T3190—2016
4.3数据结构定义
4.3.1Type:UserContentlnfo
表示某个用户的上网信息见表2。表2UserContentlnfo数据结构
MSISDN
UserCode
Cellid
xsd:string
xsd:string
xsd:string
xsd:string
xsd:string
xsd:string
Type:UserlnternetMode
表示某个用户的上网方式见表3。必选/可选
手机号码
用户伪码
Cellid
表3UserlnternetMode数据结构
RatType
xsd:string
xsd:string
4.3.3Type:IsUsingCellularData表示某个用户是否通过蜂窝网络上网见表4。必选/可选
接入类型
网络类型,如1=3G,2-2G
表4IsUsingCelluarData数据结构元素
IsUsingCelluarData
xsd:int
4.3.4 Type:UserldentityAuthentication表示某个用户身份鉴权结果信息,见表5。必选/可选
1=蜂窝数据上网,0=其他方式上网。表5UserldentityAuthentication数据结构元素
UserldentityAuthentication
4.4流程图
xsd:int
必选/可选
1=成功,0=失败。
图2展示了获取用户上网信息、用户上网方式、用户手机号码/用户是否通过蜂窝数据上网、用户伪码信息、用户身份鉴权结果信息的场景。4
资源分别为:
应用服务器
11.取用户上网售息
1/用广上网方式
移动立联网用广上工文盛矩平台/用户是否道过蜂高数据上网
用户身份鉴权结果言息
用户机号码
用户为码信息
2参教校验
3逻辑处理
4消息封装
5.返回结果
图2流程
获取用户上网信息,使用以下资源:YD/T3190—2016
http://(serverRoot)/userContentPerception/(apiVersion)/userContentlnfo/(uniqueValue)用户上网方式,使用以下资源:http://(serverRoot)/userContentPerception/(apiVersion)/userlnternetMode/(uniqueValue)用户是否通过蜂窝数据上网,使用以下资源:http://(serverRoot)/userContentPerception/(apiVersion)/isUsingCelluarData/(uniqueValue)用户身份鉴权结果信息,使用以下资源:http://(serverRoot)/userContentPerception/(apiVersion)/userldentityAuthentication/(uniqueValue)/(MSISDN)
用户手机号码,使用以下资源:http://(serverRoot)/userContentPerception/(apiVersion)/(MSISDN)/(uniqueValue)用户伪码信息,使用以下资源:http://(serverRoot)/userContentPerception/(apiVersion)/userCode/(uniqueValue)步骤1.应用程序通过执行GET操作,请求移动互联网用户上下文感知平台给出带有给定鉴权参数标识的移动互联网用户上下文感知信息;步骤2~5.移动互联网用户上下文感知平台进行参数校验、逻辑处理和消息封装后返回结果。5
YD/T3190—2016
5资源详细规范
5.1资源:用户上网信息
5.1.1请求资源URL
所使用的资源是:
http://(serverRoot)/userContentPerception/(apiVersion)/userContentInfo/(uniqueValue)该资源用来进行用户上网信息相关的操作。5.1.2请求URL变量
对于所有的HTTP命令,下列请求URL变量是通用的,具体变量名称及说明见表6。表6请求URL变量
serverRoot
apiVersion
uniqueValue
服务器的URL基本构成:hostname+port+basepath.Port和basepath是可选的。例:example.com/exampleAPI
要使用的API客户端版本
为128bit的唯一随机数,作为应用服务器和移动互联网上下文感知平台确定的用户鉴权参数5.1.3
响应代码和错误处理
关于适用于移动互联网用户上下文感知业务API的异常策略和异常服务的错误代码见附录A,具体见表A.1。
5.1.4.1描述
返回用户上网信息。
5.1.4.2请求
GET/exampleAPI/userContentPerception/v1/userContentInfo/uniqueValueHTTP/1.1Accept:application/xml
Authorization:
appKey-\de33dc7dcc5bfbba14ebac548dab3b6fa6ale8f9\,token=\60961e2870ed22f01bf39f327cadb8ff50559f08\
Host:example.com
5.1.4.3响应
HTTP/1.1200OK
Date:Thu,04Jun200902:51:59GMTContent-Type:application/xmlContent-Length: nnnn
YD/T3190—2016
< userContentPerception:UserContentInfo xmlns: userContentPerception =\urn:ccsa:xml:rest:netapi:userContentPerception:1\
tel:+19585550100365574384A3B0764BC4A58E17139B28886050502710785046001155161218141063
13821
资源不允许的方法。返回的HTTP错误状态是405。按照IETFRFC2616中14.7节,服务器在响应时还应包括‘AlloW:GET’字段。5.1.6POST
资源不允许的方法。返回的HTTP错误状态是405。按照IETFREC2616中14.7节,服务器在响应时还应包括‘Allow:GET”字段。5.1.7DELETE
资源不允许的方法。返回的HTTP错误状态是405。按照IETFRFC2616中14.7节,服务器在响应时还应包括‘AlloW:GET'字段。
5.2资源:用户上网方式
5.2.1请求资源URL
所使用的资源是:
http://(serverRoot)/userContentPerception/(apiVersion)/userInternetMode/(uniqueValue)该资源用来进行用户上网方式相关的操作。5.2.2请求URL变量
对于所有的HTTP命令,下列请求URL变量是通用的,具体变量名称及说明见表7。7
YD/T3190—2016
serverRoot
apiVersion
uniqueValue
表7请求URL变量
basepath是可选的,例:
服务器的URL基本构成:hostname+port+basepathPort和example.com/exampleAPI
要使用的API客户端版本
为128bit的唯一随机数,作为应用服务器和移动互联网上下文感知平台确定的用户鉴权参数5.2.3响应代码和错误处理
关于适用于移动互联网用户上下文感知业务API的异常策略和异常服务的错误代码,请查阅附录A,具体见表A.1。
5.2.4.1描述
返回用户上网方式。
5.2.4.2请求
GET/exampleAPI/userContentPerception/v1/userInternetMode/uniqueValueHTTP/1.1Accept:application/xml
Authorization:appKey-\de33dc7dcc5bfbba14ebac548dab3b6fa6ale8f9\,token=-\60961e2870ed22f01bf39f327cadb8ff50559f08\Host:example.com
5.2.4.3响应
HTTP/1.1200OK
Date:Thu,04 Jun200902:51:59GMTContent-Type:application/xmlContent-Length:nnnn
3gnet
1
YD/T3190—2016
资源不允许的方法。返回的HTTP错误状态是405。按照IETFRFC2616中14.7节,服务器在响应时还应包括“AlloW:GET'字段。
5.2.6POST
资源不允许的方法。返回的HTTP错误状态是405。按照IETFRFC2616中14.7节,服务器在响应时还应包括“Allow:GET’字段。5.2.7DELETE
资源不允许的方法。返回的HTTP错误状态是405。按照IETFRFC2616中14.7节,服务器在响应时还应包括‘AlloW:GET”字段。5.3资源:是否通过蜂窝数据上网5.3.1请求资源URL
所使用的资源是:
http://(serverRoot)/userContentPerception/apiVersion)/userlnternetMode/(uniqueValue)该资源用来进行是否通过蜂窝数据上网相关的操作。5.3.2请求URL变量
对于所有的HTTP命令,下列请求URL变量是通用的,具体变量名称及说明见表8。表8请求URL变量
serverRoot
apiVersion
uniqueValue
服务器的URL基本构成:hostname+port+basepath.Port和basepath是可选的,例:example.com/exampleAPI
要使用的API客户端版本
为128bit的唯一随机数,作为应用服务器和移动互联网上下文感知平台确定的用户鉴权参数5.3.3响应代码和错误处理
关于适用于移动互联网用户上下文感知业务API的异常策略和异常服务的错误代码,请查阅附录A,具体见表A.1。
5.3.4.1描述
返回用户是否通过蜂窝数据上网结果。5.3.4.2请求
GET/exampleAPI/userContentPerception/v1/isUsingCelluarData/uniqueValueHTTP/1.19
小提示:此标准内容仅展示完整标准里的部分截取内容,若需要完整标准请到上方自行免费下载完整标准文档。