网格化社会服务管理信息系统技术规范_第2部分：通用接口_征求意见稿 doc

Size: px

Start display at page:

Download "网格化社会服务管理信息系统技术规范_第2部分：通用接口_征求意见稿 doc"

锤钠栾
7 years ago
Views:

1 ICS 点击此处添加 ICS 号点击此处添加中国标准文献分类号 DB 地方标准 DB11/T XXXX.3 XXXX 网格化社会服务管理信息系统技术规范第 3 部分 : 通用数据接口 Grid social services and management information system technical specification Part 3:General data interface 点击此处添加与国际标准一致性程度的标识 ( 征求意见稿 ) XXXX - XX - XX 发布 XXXX - XX - XX 实施北京市质量技术监督局发布

2 目次前言... II 1 范围缩略语接口架构整体框架调用流程技术要求接口调用方式请求信息结构返回信息结构异常处理重试机制事务机制安全要求用户认证信息加密备份... 5 附录 A( 资料性附录 ) 通用接口调用示例... 6 A.1 功能... 6 A.2 接口扩展设计... 6 A.3 请求信息... 6 A.4 返回结果... 7 I

3 前言 DB11/T XXXX 网格化社会服务管理信息系统技术规范总标题下, 分为如下三部分 : 第 1 部分 : 总则 ; 第 2 部分 : 数据 ; 第 3 部分 : 通用数据接口本部分为 DB11/T XXXX 的第 3 部分本部分按照 GB/T 给出的规则起草本部分由北京市社会建设工作办公室提出并归口本部分的起草单位 : 北京市社会建设工作办公室北京市密云区社会建设工作办公室北京长风信息技术产业联盟北京数字政通科技股份有限公司方正国际软件有限公司首都信息发展股份有限公司北京有生博大软件技术有限公司北京国研数通软件技术有限公司北京中关村科技发展 ( 控股 ) 股份有限公司本部分的主要起草人 : 王丽竹刘致杰李浩张同银杨国林纪海明冷祯鹏宗君王晓娟张婷曹芹李悦庞奎徐峰赵斌吴传强常利红吴花春黄雷 II

4 网格化社会服务管理信息系统技术规范第 3 部分 : 通用数据接口 1 范围本部分规定了网格化社会服务管理信息系统中通用接口服务的技术实现接口功能参数以及接口返回数据等信息本部分适用于网格化社会服务管理信息系统设计和研发人员, 系统维护人员以及与网格化社会服务管理信息系统对接的外部应用的开发人员 2 缩略语 SOAP 简单对象访问协议 (Simple Object Access Protocol) WSDL Web Service 描述语言 (Web Services Description Language) XML 可扩展标记语言 (Extensible Markup Language) XSD XML 结构定义 (XML Schemas Definition ) 3 接口架构 3.1 整体框架通用接口实现机制如图 1 图 1 接口服务框架结构图网格化社会服务管理采用基于 SOAP 协议的 Web Service 技术来实现不同系统之间的信息传输 ; 需要进行信息传输的各子系统通过发布 Web Service 服务, 提供数据交换接口, 从而实现数据业务的交互网格化社会服务管理系统中的运行管理子系统对访问接口的系统进行用户身份和权限认证 3.2 调用流程接口调用流程如图 2 所示 : 1

5 网格化社会服务管理系统 Web service 服务返回结果服务请求对接系统图 2 接口调用流程具体流程如下 : 各对接系统向 Web Service 服务发送服务请求 ; Web Service 服务收到服务请求后, 进行相应的操作并返回结果 ; Web Service 服务宜支持以下四种调用模式 : 简单请求应答模式, 即一次请求对应一次应答或者没有应答 ; 多次应答模式, 即一次请求对应多次应答 ; 混合应答模式, 即对请求后的应答不能完成全部数据传送, 网格化社会服务管理信息系统还需要通过其他方式把完整数据提供给服务请求方 ; 订购通知模式, 即服务请求方订购网格化社会服务管理信息系统发布的主题, 当与订购主题相关的事件发生时, 网格化社会服务管理信息系统通知服务请求方 3.3 技术要求 a) 信息描述语言遵守 WSDL Version1.2; b) XML 数据的消息格式遵守 SOAP 规范 ; c) XML 数据使用 XML Schema 进行描述 ; d) 编码格式采用 UTF-8 4 接口调用信息结构 4.1 请求信息结构接口中的请求消息采用 XML 格式, 其 XSD 定义如图 3 所示请求消息分成两个部分 : 第一部分是控制信息, 包括协议版本服务请求系统 ID 服务请求 ID 加密方案请求者身份等 ; 第二部分是请求信息的具体内容 2

6 图 3 请求信息 XSD 请求信息 XML 格式见图 4, 请求信息 XML 标签含义见如表 1 <DataCenterXML> <Request> <Version></ Version> <SystemID></SystemID> <SessionID></SessionID> <EncryptionScheme ></EncryptionScheme > <Authentication> <UserName></UserName> <Password></Password> </Authentication> <RequestData></RequestData> </Request> </DataCenterXML> 图 4 请求信息 XML 格式序号 XML 标签标签说明 1 DataCenterXML 根标签 2 Request 服务请求信息子标签 3 Version 协议版本号 4 SystemID 服务请求系统 ID 5 SessionID 服务请求 ID 6 EncryptionScheme 加密方案, 即对后续各 XML 元素内容进行加密 3

7 时采用的加密方式 0 表示不加密 7 Authentication 请求者身份子标签 8 UserName 用户名称 9 Password 用户密码 10 Ext1 预留标签, 用于扩展后续控制信息 11 Ext2 预留标签, 用于扩展后续控制信息 12 RequestData 请求信息子标签, 可以根据需要进一步扩展表 1 请求信息 XML 标签含义 4.2 返回信息结构接口中的返回消息采用 XML 格式, 其 XSD 定义如图 5 所示请求消息包括两个部分 : 第一部分是控制信息, 包括服务请求 ID 和加密方案 ; 第二部分是返回信息, 包括返回状态和返回数据图 5 返回信息 XSD 返回信息 XML 格式见图 6, 返回信息 XML 标签含义见如表 2 <DataCenterXML> <Response> <SessionID></SessionID> <EncryptionScheme ></EncryptionScheme > <ReturnMessage> <Code></Code> <Message></Message> </ReturnMessage> <ResponseData></ResponseData> </Response> </DataCenterXML> 图 6 返回信息 XML 格式 4

8 序号 XML 标签标签说明 1 DataCenterXML 根标签 2 Response 返回信息子标签 3 SessionID 服务请求 ID 4 EncryptionScheme 加密方案, 即对后续各 XML 元素内容进行加密时采用的加密方式 0 表示不加密 5 ReturnMessage 返回状态子标签 8 Code 返回代码 9 Message 返回状态信息 10 ResponseData 返回信息子标签, 可以根据需要进一步扩展表 2 返回信息 XML 标签含义 5 异常处理 5.1 重试机制调用方调用服务, 最多尝试 3 次, 即 : 第 1 次调用失败出现异常, 重新调用该接口 ; 第 2 次调用失败出现异常, 再次重新调用该接口 ; 第 3 次调用失败, 出现异常, 则不再重试 5.2 事务机制在调用数据更新服务时, 如提交修改删除等, 出现异常应提供事务处理机制 6 安全要求 6.1 用户认证应提供对服务调用者的认证机制 a) 服务调用者在调用接口服务时应对调用者进行身份验证 ; 应定期对身份验证信息进行更新 ; b) 宜为不同的服务调用者分配不同权限 ; c) 宜为不同的操作限定不同的交互方式在进行删除提交更新等操作时, 宜针对每次操作分别进行身份认证 ; 在进行查询操作时, 可以采取一次身份认证多次查询的方式 6.2 信息加密 a) 宜对请求参数中的身份元素和返回参数中的敏感数据进行加密处理 ; b) 对 XML 加密可参照 W3C 的 XML 加密标准 ; c) 加密方法宜采用对称加密和非对称加密相结合的方法 6.3 备份服务服务器宜提供双机热备 5

9 附录 A ( 资料性附录 ) 通用接口调用示例本示例调用方式, 适用于中心到节点 ( 如市级数据中心到区级节点 ) 节点到节点( 如区级节点之间 ) 节点到中心( 如区级节点到市级数据中心 ) 等各种系统之间的网格化社会服务管理相关数据接口服务的调用本示例以某市级数据中心向某区节点调用查询街道信息为例, 来说明接口的调用 A.1 功能本示例实现的功能是通过街道编码查询街道信息 A.2 接口扩展设计在实现某些具体业务需求时, 应对通用接口进行进一步扩展设计, 以提供满足特定需求下的技术实现对通用接口的扩展设计包括交互模式定义请求信息的 RequestData 标签扩展定义和返回信息的 ResponseData 标签扩展定义本示例交互模式选择简单请求应答模式,RequestData 标签和 ResponseData 标签的扩展定义见表 A.1 序号 XML 标签标签说明 1 ReqestType 请求服务类型应为所有服务定义请求服务类型代码 getstreeinfo: 通过 ID 号查询街道信息 getcommunityinfo: 通过 ID 号查询社区信息 2 Code 0: 成功 -1: 调用的服务不存在 -2: 没有查到符合条件的信息 3 StreetID 街道 ID 号 4 StreetName 街道名称 5 StreetAddress 街道地址表 A.1 A.3 请求信息请求信息的 XML 内容见图 A.1 <?xml version='1.0' encoding='utf-8'?> <DataCenterXML> 6

10 <Request> <Version>1.0</ Version> <SystemID>100</SystemID>  <SessionID> </SessionID>  <Authentication> <UserName>user100</UserName>  <Password>psd100</Password>  </Authentication> <RequestData> <ReqestType>getStreetInfo</ ReqestType>  <StreetID> </StreetID>  </RequestData> </Request> </DataCenterXML> 图 A.1 A.4 返回结果 A.4.1 请求成功请求成功的返回结果示例见图 A.2 <DataCenterXML> <Response> <SessionID> </SessionID>  <ReturnMessage> <Code>0</Code>  <Message></Message> </ReturnMessage> <ResponseData> <StreetID> </StreetID>  <StreetName> 某某街道 </StreetName>  <StreetAddress> 某某路 XX 号 </ StreetAddress >  </ResponseData> </Response> </DataCenterXML> 图 A.2 A.4.2 请求失败请求失败返回结果的示例见 A.3 7

11 <DataCenterXML> <Response> <SessionID> </SessionID>  <ReturnMessage> <Code>-2</Code> <! 本次调用失败 --> <Message> 没有符合街道代码对应的街道 </Message>  </ReturnMessage> </Response> </DataCenterXML> 8

<4D6963726F736F667420576F7264202D20B9FABCD2BBFAB9D8B0ECB9ABBDA8D6FEBACDB4F3D0CDB9ABB9B2BDA8D6FEC4DCBAC4BCE0B2E2CFB5CDB3C8EDBCFEBFAAB7A2D6B8B5BCCBB5C3F7CAE92E646F63>

<4D6963726F736F667420576F7264202D20B9FABCD2BBFAB9D8B0ECB9ABBDA8D6FEBACDB4F3D0CDB9ABB9B2BDA8D6FEC4DCBAC4BCE0B2E2CFB5CDB3C8EDBCFEBFAAB7A2D6B8B5BCCBB5C3F7CAE92E646F63> 附件 : 国家机关办公建筑和大型公共建筑能耗监测系统软件开发指导说明书住房和城乡建设部二〇〇九年二月前言为指导各地国家机关办公建筑和大型公共建筑能耗监测系统建设, 住房和城乡建设部组织有关专家, 在总结吸收国内已