主要用能单位上传数据接口规范.docx

《主要用能单位上传数据接口规范.docx》由会员分享，可在线阅读，更多相关《主要用能单位上传数据接口规范.docx（23页珍藏版）》请在优知文库上搜索。

1、附件2武汉市节能才智管理系统数据接口规范武汉市发展和改革委员会2013年12月前言为指导我市各级节能才智管理系统建设，市发改委组织有关专家，以我国现行相关标准为依据，结合我市节能才智管理系统建设、验收和运行管理要求，探讨制定了本数据接口规范。本规范包括主要用能单位上传数据接口标准规范和市区各级系统上传数据接口标准规范两部分，其中两部分包括了接口的标准应用范围、接口的实现、接口的要求、术语和定义和基本原则。本规范由市发改委负责管理和说明。1 .主要用能单位上传数据接口规范51.1标准应用范围51.2术语和定义51.3基本原则51.4接口实现6数据供应方6数据接收方61.4.3接口的实现方式714

2、4传输方式71.4.5传输协议7传输过程7编码原则8接口的脸证方式8运用策略91.5接口数据的要求及保障92 .区分系统上传数据接口规范IO2.1 标准应用范围102.2 术语和定义IO2.3 基本原则102.4 接口实现11数据供应方112.4.2数据接收方12接口的实现方式122.4.4传输方式12传输协议12传输过程12编码原则13接口的验证方式13运用策略142.5 接口数据的要求及保障14附录1数据果集骞身份认证过程和数据加密15附录2数据枭集骞或子系统和市数据中心通信过程16附录3数据传输的XM1.数据格式171 .主要用能单位上传数据接口规范1.1 标准应用范围本标准主要为解决主

3、要用能单位与市/区系统数据交互问题，指导主要用能单位向武汉市或各区节能才智管理系统上传能耗数据。1.2 术语和定义名词说明接口规范指本文档数据供应方主要用能单位节能才智管理子系统数据接收方武汉市/各区节能才智管理系统日志指接口系统在操作过程中数据处理结果的数据库记录或文件。1.3基本原则为了保证数据供应方和数据接收方之间高效、精确地交换数据，因此接口规范的编制应符合如下原则： 数据供应方和数据接收方之间接口应具备完整性、规范性、开放性和敏捷性； 接口定义遵循易理解、易运用、易沟通、便利扩展的原则； 保证数据供应方和数据接收方的数据一样性； 在满意业务需求的前提下，使接口数据量最少，最大限度地减

4、轻数据接收方的压力； 具有牢靠完善的接口数据传输与错误订正机制，保证数据的正确性和完整性。数据供应方数据供应方应满意以下要求与功能：D保证按时供应接口规范规定的数据内容；2）对接口数据供应相关的跄证功能，保证数据的精确性、一样性;3）若相关系统有变更，则要求在变更前供应变更内容说明，并刚好更新本接口规范及相关附件的相应内容：4）遵循本接口规范中规定的验证规则；5）应刚好解决接口数据供应过程中出现的问题。6）对于未尽事宜，应同数据接收方协商解决。7）数据供应方应具有在上传数据之前对数据的加密的功能。8）数据供应方的数据接口应能依据数据接收方的接口更新和升级，敏捷的调整，达到敏捷的与数据接收方的数

5、据对接。9）能够满意数据接收方所要求的数据接收频率，依据上传频率自动将所需数据传送至系统。10）用能单位在传输数据时候，如突遇网络异样或其他异样状况，应具有断点续传和补全历史数据的功能。11）具有用能单位自身内部的用能单位子系统，能够读取到设备的能耗数据，将数据接收方所需的数据依据上传频率传送至市系统。数据接收方I）按时接收接口规范规定的相关数据内容。2）对接收的数据供应验证功能。3）遵循本接口规范中规定的验证规则和变更说明。4）对于未尽事宜，应同数据供应方协商解决。5）数据接收方具有设置数据供应方的上传权限的功能。6）数据接收方能够依据配置量限制数据供应方的数据量。1.4.3接口的实现方式I

6、.采纳服务（SoA理念）的方式供应数据共享；接口交互技术采纳WebServices方式。2 .交换内容组织格式统一采纳XM1.方式，字符编码格式采纳UTF-8o3 .XM1.解析技术采纳SAX解析技术（解析器可自编程，1.4.4传输方式数据主要通过数据接口的方式进行传输。详细要求包括： 支持网络模式传输，可以实现跨越局域网络、广域网络等系统的数据传送获得。 支持对接口机的IP地址、帐户、口令、存取书目的验证。145传输协议接口应支持TCPZ1.P（HTTP、FTP）网络协议。传输过程数据传输应支持： 实时、高效和平安牢靠地传送数据； 传输过程中的差错限制。数据接口处理过程： 数据接收方在接收数

7、据之前对数据供应方进行平安验证。O数据接收方接收数据或文件，并校验是否胜利获得； 若胜利，则对数据包或文件名进行标识并存放在相应数据库或书目； 若失败，则对数据包或文件名进行读取失败标识，存放在相应数据库或书目，并通知相关系统刚好处理故障，协商重传时间。编码原则1 .对全部交互对象及对象属性统一命名2 .方法、参数名称采纳首字母小写，后面每个单词首字母大写的形式，缩写为1-3个字母的参考第一个规则(如getUserID.getUserName)接口的触证方式为了保证能源数据的精确性，必需对数据供应方与数据接收方之间的数据接口进行骁证，接口数据的验证由接口双方共同负责。实时验证：每次数据供应方调

8、用数据接收方接口进行数据交互时，对交互的数据进行给证。脸证方法数据供应方在上报数据前依据报表数据要求和接口数据要求对上报数据进行初步校验。数据接收方在接收到上报数据后对数据格式、数据长度、数据的完整性进行校验。运用策略 调用时间依据数据接收方所须要的上传频率来进行数据上传。O调用频率依据数据接收方所须要的上传频率要求可以多次调用。 触发机制由数据供应方向数据源供应方推送数据。1.5接口数据的要求及保障数据接收方在发觉数据错误时，必需刚好记录日志，并将校验通过的数据和校验失败的数据转存到相应字段中。须要对数据进行逻辑校验： 主键检杳主键唯一性校验，检查接口数据中是否违反规范定义的唯一性约束； 数

9、据类型及格式检查字段类型检查，检查各字段类型是否与规范定义一样； 数据值域检查对数据的取值有效检查。2.区分系统上传数据接口规范2.1 标准应用范围本标准主要为解决武汉市各区分系统与市系统数据交互问题，指导各区分系统向市系统上传能耗数据。2.2 术语和定义名词说明接口规范指本文档数据供应方武汉市各区节能才智管理分系统数据接收方武汉市节能才智管理系统日志指接口系统在操作过程中数据处理结果的数据库记录或文件。2.3 基本原则为了保证数据供应方和数据接收方之间高效、精确地交换数据,因此接口规范的编制应符合如下原则： 数据供应方和数据接收方之间接口应具备完整性、规范性、开放性和敏捷性； 接口定义遵循易

10、理解、易运用、易沟通、便利扩展的原则； 保证数据供应方和数据接收方的数据一样性；令在满意业务需求的前提下，使接口数据量最少，最大限度地减轻数据接收方的压力；令具有牢靠完善的接口数据传输与错误处理机制。数据供应方数据供应方应满意以下要求与功能：D保证按时供应接口规范规定的数据内容；2）对接口数据供应相关的跄证功能，保证数据的精确性、一样性;3）若相关系统有变更，则要求在变更前供应变更内容说明，并刚好更新本接口规范及相关附件的相应内容：4）遵循本接口规范中规定的验证规则；5）应刚好解决接口数据供应过程中出现的问题。6）对于未尽事宜，应同数据接收方协商解决。7）上传数据前应有对数据的打包压缩和加密的

11、处理过程。8）数据供应方在进行接口开发时,应具有敏捷和快速与数据接收方进行对接，包括在后期的接口迁移和升级，能快速的与数据接口进行对接传输数据。9）能够满意数据接收方依据实际需求所须要的数据接收频率，依据上传频率自动将所需数据传送10）数据供应方在传输数据时候，突遇网络异样或其他异样状况，应具有断点续传和补全历史数据的功能。11）具有接收到用能单位级能管中心的能耗数据的功能，以及用能单位上报的数据。12）能够保证用能单位到地市系统，地市系统到省系统的数据数据一样性和完整性。2.4.2数据接收方D按时接收接口规范规定的相关数据内容：2）对接收的数据供应验证功能；3）遵循本接口规范中规定的验证规则

12、和变更说明。4）对于未尽事宜，应同数据供应方协商解决。5）数据接收方对数据供应方的上传数据权限安排和设置。6）数据接收方对数据供应方的数据量限制。接口的实现方式1 .采纳服务（SOA理念）的方式供应数据共享；接口交互技术采纳WebServices方式。2 .交换内容组织格式统一采纳XM1.方式，字符编码格式采纳UTF&3 .XM1.接析技术采纳SAX解析技术（解析器可自编程2.4.4传输方式数据主要通过数据接口的方式进行传输。详细要求包括：支持网络模式传输，可以实现跨越局域网络、广域网络等系统的数据传送获得。支持对接口机的IP地址、帐户、口令、存取书目的验证。传输协议接口应支持TCPz1.P（

13、HTTP、FTP）网络协议。传输过程数据传输应支持：实时、高效和平安牢靠地传送数据；传输过程中的差错限制。传输过程中如有网络出现异样或其他异样状况导出数据不能正常上传至系统，数据供应方能够自动进行续传或补齐丢失数据的功能。数据接口处理过程：数据接收方在接收数据之前对数据供应方进行平安验证。数据接收方接收数据或文件，并校验是否胜利获得；若胜利，则对数据包或文件名进行标识并存放在相应数据库或书目；若失败，则对数据包或文件名进行读取失败标识，存放在相应数据库或书目，并通知相关系统刚好处理故障，协商重传时间。编码原则1 .对全部交互对象及对象属性统一命名2 .方法、参数名称采纳首字母小写，后面每个单词

14、首字母大写的形式，缩写为1-3个字母的参考第一个规则(如getUserID.getUserName)接口的般证方式为了保证能源数据的精确性，必需对数据供应方与数据接收方之间的数据接口进行脸证，接口数据的验证由接口双方共同负责。实时验证：每次数据供应方调用数据接收方接口进行数据交互时，对交互的数据进行验证。 验证方法 数据供应方在上报数据前依据报表数据要求和接口数据要求对上报数据进行初步校验。 数据接收方在接收到上报数据后对数据格式、数据长度、数据的完整性进行校验。运用策略 调用时间定于规定上报期内的任何时段，能耗实时数据依据数据接收方的频率进行上传 调用频率依据事实上报要求可以多次调用，能耗实时数据依据数据接收方的频率进行多次调用 触发机制由数据供应方向数据源供应方推送数据2.5接口数据的要求及保障数据接收方在发觉数据错误时，必需刚好记录日志，并将校验通过的数据和校验失败的数据转存到相应字段中。须要对数据进行逻辑校验.令主键检查主键唯一性校验，检查接口数据中是否违反规范定义的唯一性约束；数据类型及格式检查字段类型检查，检查各字段类型是否与规范定义一样；数据值域检查对数据的取值有效检查。附录1数据采集器身份认证过程和数据加密1 .身份认证过程数据中心运用MD5