IPTV业务管理平台与业务系统接口技术.docx

IPTV业务管理平台与业务系统接口技术.docx

《IPTV业务管理平台与业务系统接口技术.docx》由会员分享，可在线阅读，更多相关《IPTV业务管理平台与业务系统接口技术.docx（47页珍藏版）》请在冰豆网上搜索。

IPTV业务管理平台与业务系统接口技术

文件编号：

SHDX/ZS/CZ/JG/002/A/2008

中国电信集团上海市电信公司

IPTV业务管理平台与业务系统接口技术规范V2.2

1

目的

本规范是在中国电信集团公司发布的《IPTV业务管理平台与业务系统接口技术规范V2.0》的基础上，根据中国电信上海公司IPTV运营的实际情况，进一步调整修订而成的。

本规范供引入IPTV能力平台设备、IPTV业务管理平台设备时参照执行。

本技术规范的增补、修订和解释权归中国电信上海公司所有。

如中国电信上海公司在此之前的文件与本技术规范有矛盾，按此技术规范执行。

本技术规范自发布之日起实施。

2适用范围

本规范规定了IPTV业务管理平台与业务系统之间的接口。

本规范适用于IPTV业务管理平台、EPG服务系统、内容分发系统之间的接口开发。

为中国电信上海公司IPTV机顶盒和平台的接口开放的测试提供依据。

为中国电信上海公司IPTV能力平台设备、IPTV业务管理平台设备的选择提供了依据。

3引用文件/标准

下列文件中的条款通过本标准的引用而成为本标准的条款。

凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本标准，然而，鼓励根据本标准达成协议的各方研究是否可使用这些文件的最新版本。

凡是不注日期的引用文件，其最新版本适用于本标准。

RFC2616:

HypertextTransferProtocol

RFC3275:

ExtensibleMakeupLanguage

W3C:

WebServicesDescriptionLanguage

《IPTV业务管理平台技术规范》

4定义/术语

EPGElectronicProgrammerGuide电子节目单

HTTPHypertextTransferProtocol超文本传输协议

IPInternetProtocol网络协议

MACMediaAccessControl媒体访问控制层

SOAPSimpleObjectAccessProtocol简单对象访问协议

STBSetTopBox机顶盒

URLUniformResourceLocator统一资源定位符

5IPTV业务管理平台与业务系统接口

5.1总体框架

业务系统包括EPG服务系统、内容分发系统、增值业务系统和其他IPTV的业务系统，IPTV业务管理平台与业务系统的总体框架如图所示：

图5-1-1：

IPTV业务管理平台与业务系统框架图

IPTV业务管理平台与业务系统接口包括以下接口：

a）EPG首页鉴权接口

●接口描述：

本接口在用户访问EPG首页时，EPG服务系统向业务管理平台请求鉴权。

●承载协议：

SOAP

b）UserToken更新接口

●接口描述：

本接口在用户令牌UserToken（参见《机顶盒与IPTV业务运营平台接口技术规范》）失效时，EPG服务系统重定向到业务管理平台请求新的UserToken。

●承载协议：

HTTP

c）Session丢失后获取接口

●接口描述：

本接口机顶盒访问EPG平台时，EPG平台通过Session（或cookie）记忆用户的临时身份凭证（UserToken）。

但是，由于Session（或Cookie）的时限性，使得机顶盒在一段时间内没有访问EPG页面时，机顶盒将丢失与EPG之间的Session，从而使得EPG丢失用户的UserToken，无法继续为该用户机顶盒提供IPTV服务。

●承载协议：

HTTP

d）业务鉴权接口

●接口描述：

本接口在用户通过EPG请求业务资源时，EPG服务系统向业务管理平台请求业务鉴权，业务管理平台将鉴权结果返回给EPG服务系统。

●承载协议：

SOAP

e）业务订购接口

●接口描述：

本接口在用户请求使用业务时，EPG服务系统向业务管理平台请求业务订购，用户完成订购后，EPG服务系统保存订购信息，再返回处理页面给用户。

●承载协议：

SOAP

f）直播频道列表更新接口

●接口描述：

本接口在用户请求订购直播频道，当业务管理平台返回订购成功响应后，EPG服务系统将用户重定向至业务管理平台，要求重新设置直播频道列表。

业务管理平台通过CTCSetConfig设置订购成功的频道列表，并将机顶盒重定向至EPG服务系统。

●承载协议：

HTTP

g）产品包信息获取接口

●接口描述：

本接口为EPG服务系统向业务管理平台请求产品包信息，业务管理系统将产品包信息返回给EPG服务系统。

●承载协议：

SOAP

h）用户身份重定向接口

●接口描述：

本接口在用户请求使用业务时，接收到HTTP重定向命令，要求重定向到业务管理平台的业务订购页面时触发，用户完成订购后，EPG服务系统保存订购信息，再返回处理页面给用户。

●承载协议：

HTTP

i）增值业务订购查询接口

●接口描述：

增值业务平台向业务管理平台请求查询用户订购过的所有产品信息。

●承载协议：

SOAP

j）增值业务产品详细信息查询接口

●接口描述：

增值业务平台向业务管理平台请求查询用户订购过的产品详细信息。

●承载协议：

SOAP

k）增值业务产品订购接口

●接口描述：

当用户选择订购某增值业务时，增值业务平台将用户重定向至业务管理平台进行该增值业务的订购。

当用户订购成功后，业务管理平台能将用户重定向回增值业务平台显示订购结果。

●承载协议：

HTTP

l）业务能力系统数据采集接口

●接口描述：

为了进行IPTV业务的经营分析需要向IPTV平台采集相关数据。

●承载协议：

FTP

（【注】当业务能力平台、增值业务系统与业务管理平台进行横向SOAP接口进行交互时，能够对横向接口连接情况进行监测，并在横向接口连接时间超过10s的情况下通过错误提示页面告知用户，并要求机顶盒重新发起认证请求。

）

5.2EPG首页鉴权接口

5.2.1接口时序

图5-2-1-1：

EPG首页鉴权流程

5.2.2接口协议内容

承载协议：

SOAP

接口方向：

EPG服务系统→业务管理平台

接口功能：

EPG服务系统向业务管理平台请求鉴权，通过鉴权后再给用户下发EPG首页

SOAP接口请求消息EPGAuth包含如下信息：

表5-2-2-1：

请求EPGAuth

名称

说明

数据

类型

长度

（字节）

是否

必选

UserToken

业务管理平台为该用户分配的临时身份证明

String

32

M

SOAP接口应答消息EPGAuthResponse包含以下信息：

表5-2-2-2：

响应EPGAuthResponse

名称

说明

数据

类型

长度

（字节）

是否

必选

UserID

IPTV用户业务编号

String

36

M

Result

结果，0：

成功其他：

失败

String

4

M

Description

结果描述

String

256

O

UserGroupNMB

用户对应的用户分组信息标识

String

8

O

EPGGroupNMB

用户对应的EPG分组信息标识

String

8

M

STBID

机顶盒编号

string

32

O

MAC

机顶盒的MAC地址，格式为：

xx:

xx:

xx:

xx:

xx:

xx

String

13

O

Products

用户已购买的IPTV产品编号组合，组合间采用”;”分隔，组合内采用”,”分隔，分别为产品ID，内容ID，可以为以下情形：

1、ProductID：

表示整个产品的订购关系，且有效期未知；

2、ProductID,ExpiredTime：

表示整个产品的订购关系，且存在有效期；

3、ProductID,,ContentID：

未知有效期的内容订购关系，如ContentID为直播频道ID，则为直播频道订购关系，如为点播内容ID，则为点播内容订购关系；

4、ProductID,ExpiredTime,ContentID：

存在有效期的内容订购关系，如ContentID为直播频道ID，则为直播频道订购关系，如为点播内容ID，则为点播内容订购关系。

String

不定

O

TokenExpiredTime

UserToken的失效时间，格式为：

YYYYMMDDhhmmss。

缺少该参数表示在一次登录期间，永久有效。

String

14

O

5.3UserToken更新接口

5.3.1接口时序

图5-3-1-1：

UserToken更新流程图

用户UserToken更新过程如下：

a）STB向EPG服务系统发起http请求。

b）EPG服务系统检查UserToken是否过期，如果未过期，则跳转到c，如果已过期，则跳转到e。

c）EPG服务系统响应请求。

d）UserToken已过期。

e）EPG服务系统将用户请求重定向到业务管理平台，请求新的UserToken，请求参数ReturnURL,OldUserToken，Action。

f）如业务管理平台需要STB重新认证或发生频道更改需要更新频道列表，则下发重认证页面或频道更新页面；

g）STB重新认证或更新频道结束后，由页面逻辑控制发起重定向请求；

h）业务管理平台返回新的UserToken，返回参数NewUserToken、Result。

（【注】：

IPTV业务能力平台在完成用户UserToken更新后都应该再次发起首页鉴权请求，以保证当前用户已订购产品列表为最新且可用的。

）

5.3.2接口协议内容

承载协议：

HTTPGET

接口方向：

EPG服务系统重定向→业务管理平台

接口功能：

UserToken失效时，EPG服务系统重定向到业务管理平台请求新的UserToken。

请求消息包含以下关键参数

表5-3-2-1：

更新UserToken请求参数说明

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

SP的唯一标识

String

8

O

UserID

IPTV用户业务编号

string

36

O

OldUserToken

过期的UserToken

String

32

M

ReturnURL

更新UserToken后返回的URL，采用URLEncoding的ANSI方式

string

256

M

Action

操作类型，此处使用：

“UserTokenExpired”

String

20

M

响应消息

表5-3-2-2：

更新UserToken返回参数说明

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

SP的唯一标识

String

8

O

UserID

IPTV用户业务编号

string

36

M

NewUserToken

新的UserToken

String

32

M

Result

更新结果0：

成功其他：

失败

String

4

M

TokenExpiredTime

UserToken的失效时间，格式为：

YYYYMMDDhhmmss。

缺少该参数表示永久有效。

String

14

O

5.4Session丢失后获取接口

机顶盒访问EPG平台时，EPG平台通过Session（或cookie）记忆用户的临时身份凭证（UserToken）。

但是，由于Session（或Cookie）的时限性，使得机顶盒在一段时间内没有访问EPG页面时，机顶盒将丢失与EPG之间的Session，从而使得EPG丢失用户的UserToken，无法继续为该用户机顶盒提供IPTV服务。

5.4.1接口时序

为了解决这一问题，可以采用SSO流程获取用户的UserToken。

以下是机顶盒与EPG交互、Session丢失和EPG处理流程：

a）.机顶盒开机认证通过，业务管理平台为其分配临时身份凭证UserToken

b）.机顶盒访问EPG首页，携带UserToken

c）.EPG以Session（或Cookie）方式保存用户的UserToken

d）.EPG在调用业务管理平台的业务鉴权、产品订购时必需携带有效的UserToken。

EPG通过UserToken更新机制来保证UserToken的有效性。

e）.机顶盒通过访问EPG页面来维持机顶盒与EPG之间的Session有效。

机顶盒在一段时间内没有操作或者机顶盒离开EPG访问增值业务，超过Session的超时时限，机顶盒丢失与EPG之间的Session。

f）.机顶盒再次访问EPG，EPG因Session丢失，无法获得机顶盒的UserToken

g）.EPG系统将机顶盒重定向到业务管理系统，发起用户身份重定向SSO请求,携带ReturnURL等参数

h）.业务管理平台获取机顶盒的UserToken后，通过通过重定向携带参数方式，将UserToken等参数返回给EPG系统

i）.EPG获得用户身份，继续为用户提供服务。

5.4.2接口协议内容

承载协议：

HTTPSSO

接口方向：

EPG服务系统→业务管理平台

接口功能：

采用SSO流程获取用户的UserToken。

业务身份重定向SSO请求参数：

表5-4-2-1：

业务身份重定向SSO请求参数说明

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

SP的唯一标识

string

8

M

ReturnURL

返回增值业务系统页面的URL

string

256

M

ReturnInfo

返回增值业务系统页面需要携带的额外信息，可用于区分不同的SSO请求

string

256

O

Action

操作类型，此处使用：

UserTokenRequest

string

20

M

业务身份重定向SSO返回参数：

表5-4-2-2：

业务身份重定向SSO响应参数说明

名称

说明

数据

类型

长度

（字节）

是否

必选

Result

身份获取结果

0：

成功；其他：

失败

string

4

M

UserToken

IPTV用户业务编号

string

36

M

SPID

SP的唯一标识

string

8

O

UserID

IPTV用户业务编号

string

36

O

EPGGroupNMB

用户对应的EPG分组信息标识

string

8

O

UserGroupNMB

用户对应的分组信息标识

string

8

O

Description

结果描述

string

256

O

ExpiredTime

UserToken的失效时间，格式为YYYYMMDDhhmmss。

缺少在一次开机过程中该参数表示永久有效。

string

14

O

ReturnInfo

返回EPG页面需要携带的额外信息，可用于区分不同的SSO请求

string

256

O

5.5业务鉴权

5.5.1接口时序

业务鉴权接口时序流程如下：

图5-4-1-1：

业务鉴权流程图

a）终端访问业务系统的业务使用入口，请求使用某项业务；

b）业务系统要求鉴权，发起到业务管理平台的SOAP请求，携带ProductID、UserToken等信息；

c）业务管理平台根据产品、用户信息进行业务鉴权；

d）业务管理平台通过SOAP响应返回鉴权结果；

e）如果鉴权未通过，则业务系统发起业务订购的流程；

f）如果鉴权通过，则业务系统允许使用；

g）业务系统返回用户请求的实际业务内容，继续业务的使用。

5.5.2接口协议内容

承载协议：

SOAP

接口方向：

业务系统→业务管理平台

接口功能：

业务系统向业务管理平台请求使用业务

表5-4-2-1：

业务鉴权请求ServiceAuthReq

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

增值业务SP的编号，基本业务鉴权时无效

String

8

O

UserID

用户登录业务帐号

String

36

O

UserToken

业务管理平台为该用户分配的临时身份证明，这里通过EPG上传给业务管理平台

String

32

M

ProductID

IPTV产品编号

String

32

M

ServiceID

IPTV服务编号

String

32

O

ContentID

IPTV内容编号

String

32

M

TimeStamp

从1970年1月1日0时开始的毫秒数

digitstring

<=18

M

IP

IP地址

String

39

O

MAC

机顶盒的MAC地址，格式为：

xx:

xx:

xx:

xx:

xx:

xx

String

17

O

TransactionID

事务编号

string

40

O

表5-4-2-2：

业务鉴权请求响应

名称

说明

数据

类型

长度

（字节）

是否

必选

Result

0：

成功

其他：

失败

String

4

M

UserID

用户登录业务帐号

String

36

O

ProductID

产品ID

String

32

M

ServiceID

服务ID

String

32

O

ContentID

内容ID

String

32

M

STBID

机顶盒ID

string

32

O

IP

IP地址

string

39

O

MAC

机顶盒的MAC地址，格式为：

xx:

xx:

xx:

xx:

xx:

xx

string

17

O

TransactionID

事务编号

string

40

O

ExpiredTime

本订购关系的鉴权失效时间，用绝对时间表示。

格式为：

YYYYMMDDhhmmss。

如本参数为空，则表示该订购关系的鉴权长期有效；如本参数为当前时间，则表示该订购关系的鉴权一次性有效。

String

14

O

Balance

预付费用户余额，单位为

分。

如为后付费用户，该

参数缺失或为空

int

4

O

ProductList

可订购的产品列表，在订

购失败并返回“用户未订

购”的情况下携带该参数。

Product[]

不定

O

表5-4-2-2：

Product结构

名称

说明

数据

类型

长度

（字节）

是否

必选

ProductID

产品ID

String

32

M

ProductName

产品名称

String

100

M

Fee

产品价格，以分为单位

Int

4

M

PurchaseType

0：

包月支付，用户选择订购产品后，按照固定包月费用计费，在当月内无需再次向业务管理平台发起订购请求；

1：

按次支付，用户选择订购产品后，按照使用次数进行计费无需重新发起订购请求

2：

免费

3：

ppv，用户选择订购产品后，进行一次性计费。

再次使用时仍需订购该产品

4：

SVOD；

5：

PVOD；

Int

4

O

ProductDesc

产品描述

String

200

O

ListPrice

标称价格，以分为单位

Int

4

O

RentalTerm

租期

Int

4

O

LimitTimes

可使用次数

Int

4

O

5.6业务订购

5.6.1接口时序

图5-5-1-1：

即时业务订购流程图

5.6.2接口协议内容

承载协议：

SOAP

接口方向：

EPG服务系统→业务管理平台

接口功能：

用户订购业务

请求消息包含以下关键参数

表5-5-2-1：

业务订购请求参数

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

SP的唯一标识

string

8

O

UserID

IPTV用户业务编号

string

36

O

UserToken

业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递

string

32

M

ContentID

内容ID

string

32

M

ServiceID

IPTV服务编号

string

32

O

ProductID

IPTV产品编号

string

32

M

Action

操作类型：

1：

表示订购；

2：

表示退订。

String

20

M

业务管理平台返回的响应消息携带以下参数：

表5-5-2-2：

SOAP响应消息

名称

说明

数据

类型

长度

（字节）

是否

必选

Result

业务订购结果0：

成功其他：

失败

String

4

M

Description

结果描述

String

256

O

UserID

IPTV用户业务编号

string

36

O

UserToken

业务管理平台为该用户分配的临时身份证明，可采用Cookie的方式传递

string

32

O

ContentID

内容ID

string

32

M

ServiceID

IPTV服务编号

string

32

O

ProductID

IPTV产品编号

string

32

M

SPID

SP的唯一标识

string

8

O

TransactionID

订购的事务编号

string

40

O

ExpiredTime

订购关系的失效时间，格式为YYYYMMDDhhmmss。

缺少该参数表示永久有效。

String

14

O

Balance

预付费用户的费用余额，

单位为分。

如为后付费用

户，该参数缺失或为空。

Int

4

O

Fee

产品价格，以分为单位

Int

4

M

PurchaseType

0：

包月支付，用户选择订购产品后，按照固定包月费用计费，在当月内无需再次向业务管理平台发起订购请求；

1：

按次支付，用户选择订购产品后，按照使用次数进行计费无需重新发起订购请求

2：

免费

3：

ppv，用户选择订购产品后，进行一次性计费。

再次使用时仍需订购该产品

4：

SVOD

5：

PVOD

Int

4

O

5.7直播频道列表更新接口

5.7.1接口时序

图5-6-1-1：

直播频道列表更新流程图

a）STB通过业务订购接口完成对于直播频道的订购，并通过直播订购接口步骤7返回订购成功的响应。

b）EPG服务系统将用户重定向至业务管理平台，要求重新设置直播频道列表。

c）业务管理平台通过CTCSetConfig设置订购成功的频道列表，并将机顶盒重定向至EPG服务系统。

5.7.2接口协议内容

承载协议：

HTTPGET

接口方向：

EPG服务系统重定向→业务管理平台

接口功能：

直播频道订购成功后，对直播频道列表进行更新

请求消息包含以下关键参数

表5-6-2-1：

更新直播频道列表请求参数说明

名称

说明

数据

类型

长度

（字节）

是否

必选

SPID

SP的唯一标识

String

8

O

UserID

IPTV用户业务编号

string

36

M

ReturnU