华数云梯平台-平台层-服务消息总线接口规范20150714 V0.1.docx

华数下一代云电视平台规范文档 PAGE 21 华数下一代云电视项目组 下一代云电视项目-平台层 服务消息总线接口规范 2015年7月 文件修订记录 版本号 变化状态 简要说明 （变更内容和变更范围） 变更日期 变更人 备注 V0.1 C 初稿制定 2015-7-14 徐灿 *变化状态：C―创建，A—增加，M—修改，D—删除，R—复核  文件审批记录 版本号 审批人 角色 审批意见 签字 审批日期 V1.0 部门经理 同意  目录 TOC \o 1-3 \h \z \u 1. 概述 8 1.1. 适用范围 8 1.2. 参考资料 8 1.3. 缩略语 8 2. 接口访问流程 8 3. 服务消息总线接口 9 2.1. 总则 9 2.2. Http Header参数说明 10 2.3. URL参数说明 10 2.4. 静态路由引擎 GET 方法 10 2.4.1. 请求参数 10 2.4.2. 请求样例 11 2.4.3. 返回参数 11 2.4.4. 返回样例 12 2.5. 静态路由引擎 POST 方法 12 2.5.1. 请求参数 12 2.5.2. 请求样例 12 2.5.3. 返回参数 13 2.5.4. 返回样例 14 2.6. 规则路由引擎 GET 方法 14 2.6.1. 请求参数 14 2.6.2. 请求样例 15 2.6.3. 返回参数 15 2.6.4. 返回样例 15 2.7. 规则路由引擎 POST 方法 15 2.7.1. 请求参数 16 2.7.2. 请求样例 16 2.7.3. 返回参数 16 2.7.4. 返回样例 17 2.8. BPEL路由引擎 GET 方法 17 2.8.1. 请求参数 17 2.8.2. 请求样例 18 2.8.3. 返回参数 18 2.8.4. 返回样例 18 2.9. BPEL路由引擎 POST 方法 19 2.9.1. 请求参数 19 2.9.2. 请求样例 19 2.9.3. 返回参数 19 2.9.4. 返回样例 20 2.10. 特别注意 20 2.10.1. 空属性 20 2.10.2. 属性处理 21 2.10.3. 列表处理 22 2.10.4. CDATA处理 23 4. 服务消息总线提供的接口列表 25 4.1. 应用数据存储接口 25 4.2. 应用数据删除接口 25 4.3. 应用数据查询接口 25 4.4. 群发消息接口 26 4.5. 启动应用(门户)接口 26 4.6. 获取运营商用户信息接口 27 4.7. 快捷导航数据查询接口 27 4.8. 获取用户会话信息接口 28 附录1、retcode含义说明 28  概述 适用范围 参考资料 缩略语 接口访问流程 静态路由引擎处理流程 规则路由引擎处理流程 BPEL路由引擎处理流程 服务消息总线接口 总则 服务消息总线对外提供的接口统一采用 HTTP REST方式，数据统一采用JSON格式进行封装，提供get、post、put三个方法。第三方应用或系统可以采取上述方式通过服务消息总线对云梯平台进行能力和数据的调用。 Http Header参数说明 第三方应用在通过接口调用服务消息总线的必须在HTTP请求Header头中带上以下参数，否则服务消息总线将认为是非法请求予以拒绝。相关参数参见下表： HEADER参数说明: Attribute Type Use Description appid xs:string required 第三方应用的应用编号，由华数进行统一分配 token xs:string required 第三方应用申请通过后返回的token值 URL参数说明 第三方应用通过接口调用服务消息总线时，在URL中有一个必须包含且必须排序在第一个的URL参数。该参数缺失、错误或者顺序错误将导致请求予以拒绝。相关参数参见下表： HEADER参数说明: Attribute Type Use Description ESBCommand xs:string required 服务消息总线命令，对应调用不同的服务消息总线的接口命令名称，具体见每个接口中的描述 举例： http://ip:port/smbservice/smb?ESBCommand=accessUser