DB11∕T 1391.3-2017 网格化社会服务管理信息系统技术规范 第3部分：通.用数据接口

备案号:54170-2017DB11北京市质量技术监督局发布 2缩略语 3接口架构 3.1整体框架 3.2调用流程 3.3技术要求 4接口调用信息结构 4.1请求信息结构 4.2返回信息结构 5异常处理 5.1重试机制 5.2事务机制 6安全要求 6.1用户认证 6.2信息加密 附录A（资料性附录）通用数据接口使用示例 DB11/T1391《网格化社会服务管理信息系统技术规范》分为以下3个部分：——第1部分：总则；——第2部分：数据；——第3部分：通用数据接口。本部分为DB11/T1391的第3部分。本部分按照GB/T1.1-2009给出的规则起草。本部分由北京市社会建设工作办公室提出并归口。本部分由北京市社会建设工作办公室组织实施。本部分的起草单位：北京市社会建设工作办公室、北京市密云区社会建设工作办公室、北京长风信息技术产业联盟、北京数字政通科技股份有限公司、方正国际软件有限公司、首都信息发展股份有限公司、北京有生博大软件技术有限公司、北京国研数通软件技术有限公司、北京中关村科技发展（控股）股份有限公司。本部分的主要起草人：王丽竹、刘志杰、唐志华、杨国林、李浩、张同银、纪海明、冷祯鹏、宗君、王晓娟、张婷、曹芹、李悦、庞奎、徐峰、赵斌、吴传强、常利红、吴花春、黄雷。网格化社会服务管理信息系统技术规范第3部分：通用数据接口本部分规定了网格化社会服务管理信息系统中通用数据接口的接口架构、接口调用信息结构、异常处理及安全要求。本部分适用于各级网格化社会服务管理信息系统之间、各级网格化社会服务管理信息系统与相关外围信息系统之间的信息采集、处理与共享交换。2缩略语SOAP简单对象访问协议（SimpleObjectAccessProtocol)WSDLWebService描述语言（WebServicesDescriptionLanguage）XML可扩展标记语言(ExtensibleMarkupLanguage)XSDXML结构定义(XMLSchemaDefinition)3接口架构3.1整体框架通用数据接口实现机制如图1。子系统运行管理子系统web运行管理子系统权限认证对接系统图1通用数据接口框架结构图网格化社会服务管理采用基于SOAP协议的WebService技术来实现不同系统之间的信息传输；进行信息传输的各子系统应通过发布WebService服务，提供数据交换接口，从而实现数据、业务的交互。网格化社会服务管理系统中的运行管理子系统对访问接口的对接系统进行身份认证和权限认证。3.2调用流程接口调用流程如图2所示。2WebService服务返回结果服务请求图2接口调用流程具体流程如下：a)各对接系统向WebService服务发送服务请求；b)WebService服务收到服务请求后，进行相应的操作并返回结果；c)WebService服务宜支持以下四种调用模式:——简单请求应答模式，即一次请求对应一次应答或者没有应答；——多次应答模式，即一次请求对应多次应答；——混合应答模式，即对请求后的应答不能完成全部数据传送，网格化社会服务管理信息系统还需要通过其他方式把完整数据提供给服务请求方；——订购通知模式，即服务请求方订购网格化社会服务管理信息系统发布的主题，当与订购主题相关的事件发生时，网格化社会服务管理信息系统通知服务请求方。3.3技术要求接口技术要求包括：a)信息描述语言遵守WSDLVersion1.2。b)XML数据的消息格式遵守SOAP规范。c)XML数据使用XSD进行描述。d)编码格式采用UTF-8。4接口调用信息结构4.1请求信息结构接口的请求信息采用XML格式，其XSD定义如图3所示。请求信息分成两个部分：第一部分是控制信息，包括协议版本、服务请求系统ID、服务请求ID、加密方案、请求者身份等；第二部分是请求信息的具体内容。请求信息的扩展方法可参考附录A。图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格式4表1请求信息XML标签含义4.2返回信息结构接口的返回信息采用XML格式，其XSD定义如图5所示。请求信息包括两个部分：第一部分是控制信息，包括服务请求ID和加密方案；第二部分是返回信息，包括返回状态和返回数据。返回数据的扩展方法可参考附录A。图5返回信息XSD返回信息XML格式见图6，返回信息XML标签含义见表2。<DataCenterXML><Response><SessionID></SessionID><EncryptionScheme></EncryptionScheme><ReturnMessage><Code></Code><Message></Message></ReturnMessage><ResponseData></ResponseData></Response></DataCenterXML>图6返回信息XML格式表2返回信息XML标签含义5异常处理5.1重试机制调用方调用数据接口服务，最多尝试3次，即：第1次调用失败、出现异常，重新调用该接口；第2次调用失败、出现异常，再次调用该接口；第3次调用失败，出现异常，则不再重试。5.2事务机制在调用数据接口进行提交、修改、删除等数据操作时，应提供事务处理机制。6安全要求6.1用户认证6应提供对数据接口服务调用者的认证机制。a）服务调用者在调用接口服务时应对调用者进行身份验证；应定期对身份验证信息进行更新；b）宜为不同的服务调用者分配不同权限；c）宜为不同的操作限定不同的交互方式。在进行提交、修改、删除等数据操作时，宜针对每次操作分别进行身份认证；在进行查询操作时，可以采取一次身份认证多次查询的方式。6.2信息加密a)宜对请求参数中的身份元素和返回参数中的敏感数据进行加密处理；b)对XML加密可参照W3C组织的XML加密标准；c)加密方法宜采用对称加密和非对称加密相结合的方法。6.3备份数据接口服务的服务器宜提供双机热备。（资料性附录）通用数据接口使用示例本示例适用于各级网格化社会服务管理信息系统之间、各级网格化社会服务管理信息系统与相关外围信息系统之间的数据接口服务调用设计和应用。本示例以某信息系统向某区级网格化社会服务管理信息系统调用“查询街道信息”接口服务为例，说明通用数据接口的设计和使用方法。A.1功能本示例实现的功能是通过街道编码查询街道信息。A.2接口扩展设计在实现某些具体业务需求时，应对通用数据接口进行进一步扩展设计。对通用数据接口的扩展设计包括交互模式定义、请求信息的RequestData标签扩展定义和返回信息的ResponseData标签扩展定义。本示例交互模式选择简单请求应答模式，RequestData标签和ResponseData标签的扩展定义见表表A.1接口扩展信息XML标签含义A.3请求信息请求信息的XML格式见图A.1。8<?xmlversion='1.0'encoding='UTF-8'?><DataCenterXML><Request><Version>1.0</Version><SystemID>100</SystemID><!—请求接口服务的系统的ID为"100"--><SessionID>98563465324</SessionID><!--此次请求的流水号是98563465324--><EncryptionScheme>0</EncryptionScheme><!--此次服务调用信息不加密--><Authentication><UserName>user100</UserName><!--用户名--><Password>psd100</Password><!--密码--></Authentication><RequestData><ReqestType>getStreetInfo</ReqestType><!--请求服务类型为"查询街道信息"--><StreetID>123456789</StreetID><!--查询的街道ID为"123456789"--></RequestData></Request></DataCenterXML>图A.1请求信息XML格式示例A.4返回结果A.4.1请求成功请求成功的返回结果的XML格式见图A.2。<DataCenterXML><Response><SessionID>98563465324</SessionID><!--返回结果对应的请求流水号是98563465324--><EncryptionScheme>0</EncryptionScheme><!--此次返回信息不加密--><ReturnMessage><Code>0</Code><!--0表示成功--><Message></Message></ReturnMessage><ResponseData><StreetID>123456789</StreetID><!--街道ID为"123456789"--><StreetName>某某街道</StreetName><!--街道名称--><StreetAddress>某某路XX号</StreetAddress><!--街道地址--></ResponseData></Response></DataCenterXML>图A.2返回成功信息XML格式示例A.4.2请求失败请求失败返回结果的XML格式见图A.3。<DataCenterXML><Response><SessionID>98563465324</SessionID><!--