设备维护平台接口技术设计规范方案说明书[2013_05_13]
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
设备维护平台
接口技术规范说明书
（版本号V1.0）
杭州天梦科技有限公司
二◦一◦年五月
更改履历
注：更改人除形成初稿，以后每次修改在未批准确认前均需采用修订的方式进行修改
目录
1 概述 (2)
1.1编写目的 (2)
1.2预期读者 (2)
1.3参考文献 (2)
2 接口平台设计 (2)
2.1技术架构 (2)
2.1.1接口架构图 (2)
2.1.2业务流图 (3)
2.2部署方式 (4)
2.3接口标准 (4)
2.3.1技术标准 (4)
2.3.2数据规约 (5)
2.3.3 示例 (6)
3 WEBSERVICE 服务 (8)
3.1设备维护平台提供的服务 (8)
3.1.1接口服务清单 (8)
3.1.2接口服务设计 (8)
1概述
1.1编写目的
为设备维护平台的信息同步和共享，制定了统一的接口规范，用来指导各系统的接口设计、开发、联调及迁移工作。
范围：本文档主要是对设备维护平台与外围业务系统的数据交互需求进行说明。
1.2调试要求
强烈要求第三方调用者，先做测试库的接口调试，确保接口及参数调用正确, 否则将对正式库可能出现的系统故障承担主要责任。
1.3预期读者
项目组人员、各交互系统涉及到的开发厂家。
1.4参考文献
《智能交通设备维护管理系统设备接入标准》杭州天梦科技有限公司
2接口平台设计
2.1技术架构
2.1.1接口架构图
（暂缺）
2.1.2业务流图
说明：用户通过接口。
2.2部署方式
接口服务层包括 Webservice 服务、展现集成服务。
I 审權不逋i±l
TT.
維修移交
是否塞俵底虽范国
「
人工确认
维楼反逮
［否
］
稈序椎测
V 是否堆楼完工.A*
1、Webservice 服务
各系统提供的接口服务统一部署在设备维护平台接口服务层上，各系统客户
端和接口服务层用SOAP协议通过HTTP来交互，客户端根据WSDL描述文档生成SOAP请求消息发送到服务端，服务端解析收到的SOAP请求，调用Web service，然后再生成相应的SOAP应答送回到客户端。
2、展现集成服务
展现集成服务主要是应用界面集成服务，由服务提供方提供详细的URL及相关参数说明，调用方传入参数，调用服务方提供的页面进行展现。
3、平台Service组件服务
平台Service组件服务统一部署在设备维护平台接口服务层上，通过平台接口服务层进行查询操作。
2.3接口标准
2.3.1 技术标准
2.3.1.1 简述
客户端和服务器用SOAP协议通过HTTP来交互，客户端根据WSDL描述文档生成SOAP请求消息发送到服务端，服务端解析收到的SOAP请求，调用Web service，然后再生成相应的SOAP应答送回到客户端。
2.3.1.2认证机制
设备维护平台提供的所有WebService服务均需要认证授权才能被调用，Webservice 服务接收到请求后从传入参数中获取用户名和密码，进行认证，认证通过后再调用具体服务。
2.3.2数据规约
2.3.2.1 简述
客户端和服务端采用XML格式的字符串来交互业务数据，客户端将业务数据组织成XML格式的字符串作为最后一个入参调用服务端接口，服务端解析XML格式的字符串得到业务数据处理业务并把结果组织成XML格式的字符串返回给客户端。
接口调用的结果，自动序列化后，以XML格式的字符串返回，其中包含了接口调用中出现的错误描述。
2.3.2.2格式约定
若是业务接口调用，将以Dataltem_Rsp类实例序列化，表示单一数据项，内容包括操作结果、错误描述，无数据集。
若是查询接口调用，将以EntSetSerialize_Rsp类实例序列化，表示查询结果，其中包括错误描述，有数据集。
XML 字符串中，若是节点取值为null，则是VBANK—CODE xsi:nil="true"x/BANK_CODE＞，在节点中存在属性XSi：nil="true"；若是节点取值为空字符串，贝U是＜BANK_NAME/＞。
XML编码格式为“ UTF-8';
字段为日期的遵循以下约定：
1. 年月曰格式统一为“ 丫丫丫丫-MM-DD ”，女口“ 2006-06-22 ”。
2. 年月格式为“ YYYYMM ”，女口“ 200606 ”。
3. 包含时间的日期格式统一为“ YYYY-MM-DDTHH:MI:SS ”，如
“2006-06-22T14:00:00 ”。
4. 如果未约定日期格式，则DATE类型的默认为“ YYYY-MM-DD ”，如
“ 2006-06-22 ”。
2.323 格式DTD
暂缺
2.3.3示例
2.3.3.1示例：查询接口，包含数据集
xml ns:xsi="/2001/XMLSchema-i nsta nee" xml ns:xsd="/2001/XMLSchema" xml ns="/">