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