智慧城市公共信息平台平台接口与服务要求.doc
《智慧城市公共信息平台平台接口与服务要求.doc》由会员分享,可在线阅读,更多相关《智慧城市公共信息平台平台接口与服务要求.doc(74页珍藏版)》请在得力文库 - 分享文档赚钱的网站上搜索。
1、 1智慧城市公共信息平台平台接口与服务要求 1 范围 本要求 是智慧城市公共信息平台建设指南建设要求系列之接口与服 接口与服 接 口与服 务要求 。 本部分 要求 分两大部描述平台接口 分两大部描述平台接口 分两大部描述平台接口 分两大部描述平台接口 分两大部描述平台接口 要求 ,第一部分:总体 ,第一部分:总 体 ,第一部分:总体 ,第一部分:总体 要求 ,总体 要求 描述消息的总体结构、接口 访问方地址使用说明。第二部分:业务 描述消息的总体结构、接口访问方地址使用说明。 第二部分:业务 描述消息的总体结构、接口访问方地址使用说明。第二部分:业务 描述 消息的总体结构、接口访问方地址使用说
2、明。第二部分:业务 描述消息的总体结构、接 口访问方地址使用说明。第二部分:业务 描述消息的总体结构、接口访问方地址使用说 明。第二部分:业务 接口 要求 ,具体描述每个业务应用服接口的 ,具体描述每个业务 应用服接口的 要求 。也就是每一个业务接口 。也就是每一个业务接口 要求 套在总体 要求 内。只有使用业务接口 内。只有使用业务接口 内。只有使用业务接口 内。只有使 用业务接口 要求 +总体 要求 才能正常使用信息平台的应 才能正常使用信息平台的应 才能正常使用信息平台的应 才能正常使用信息平台的应 用服务来发现,查询管理资源。 本部分适用于参与公共信息平台设计和研发人员,系统维护及要求
3、 本部分适用于参与 公共信息平台设计和研发人员,系统维护及要求 本部分适用于参与公共信息平台设计和 研发人员,系统维护及要求 本部分适用于参与公共信息平台设计和研发人员,系统维护 及要求 本部分适用于参与公共信息平台设计和研发人员,系统维护及要求 本部分适用于 参与公共信息平台设计和研发人员,系统维护及要求 本部分适用于参与公共信息平台设 计和研发人员,系统维护及要求 本部分适用于参与公共信息平台设计和研发人员,系统 维护及要求 本部分适用于参与公共信息平台设计和研发人员,系统维护及要求 本部分适 用于参与公共信息平台设计和研发人员,系统维护及要求 本部分适用于参与公共信息平 台设计和研发人员
4、,系统维护及要求 本部分适用于参与公共信息平台设计和研发人员, 系统维护及要求 本部分适用于参与公共信息平台设计和研发人员,系统维护及要求 接入 公共信息平台的外部应用开发人员。 智慧城市公共信息平台-平台接口与服务要求 2 2 规范性 引用 文件 下列文件中的条款通过本部分引 用而成为。凡是注日期下列文件中的条款通过本部分引 用而成为。凡是注日期用文件,其随后 用文件,其随后 所有的修改单(不包括勘误内容) 或订版均适用于本部分, 所有的修改单(不包括勘误内容)或订版均适用于本部分, 所 有的修改单(不包括勘误内容)或订版均适用于本部分, 鼓励根据本部分达成协议的各 方研究是否可使用这些文件
5、最新版。凡不注 鼓励根据本部分达成协议的各方研究是否可 使用这些文件最新版。凡不注 日期的引用文件,其最新版本适于部分。 GB/T 21063.1 -2007 政务信息资源目录体系 第 1 部分:总体框架; GB/T 21063.2 -2007 政务信息资源目录体系 第 2 部分:技术要求; GB/T 21063.3 -2007 政务信息资源目录体系 第 3 部分:核心元数据; GB/T 21063.4 GB/T 21063.4 -2007 政务信息资源目录体系 第 4 部分: 政务信息资源分 类; GB/T 21063.5 -2007 政务信息资源目录体系 第 5 部分:政务信息资源标识 部
6、分:政务 信息资源标识 符编码方案; 本文 引用 GB/T 21063.2 GB/T 21063.2 -2007 中的附录 A 目 录服务 接口;2 本文 引用 引用 GB/T 21063.2 GB/T 21063.2 -2007 中的附 中的附 中的附 录 A 目录服务接口,及引用 目录服务接口,及引用 目录服务接口,及引用 GB/T 21063.2 GB/T 21063.2 -2007 中的附录 中的附录 C 政务信息资源目 录服务属性集 本文 引用 GB/T 21063.2 GB/T 21063.2 -2007 中的附录 中的附录 F 检 索串示例 9. 智慧城市公共信息平台-平台接口与
7、服务要求 3 3 术语 与定义 GB/T 19710 -2005 中规定的与以下术语和义适用于本部分。 目录 针对拥有共性的数据资源 针对拥有共性的数据资源 针对拥有共性的数据资源 针对拥有 共性的数据资源 /文件资 源进行分类,并且为该赋予唯一的文件资 源进行分类,并且为 该赋予唯一的文件资 源进行分类,并且为该赋予唯一的文件资 源进行分类,并且为该赋 予唯一的文件资 源进行分类,并且为该赋予唯一的文件资 源进行分类,并且为该赋予唯 一的文件资 源进行分类,并且为该赋予唯一的源标识符,该部分类及描述的集合统称为 资目录简。 结构化资源 公共信息平台享的二维库表结构数据,统称为化资源。 非结构
8、化资源 公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访 公共信息平台享的 非二维库表结构数据,例如:文本件、视频网络访 公共信息平台享的非二维库表结构数 据,例如:文本件、视频网络访 公共信息平台享的非二维库表结构数据,例如:文本件、 视频网络访 公共信息平台享的非二维库表结构数据,例如:文本件、视频网络访 问资源 等统称为非结构化。 数据交换管理者 管理信息资源结点的机构。 交换内容提供者 提供信息资源交换内容的机构。 交换内容使用者 使用信息资源交换内容的机构。 前置环境 应用单 位接入端系统软硬件及相关网络环境组成的前置元环境。 目录交换 按订阅模式进行目录资源数据的交换;
9、 桥接系统 业务数据库与共享的桥接器,保持 交换 数据库与共享的同步 数据库与共享的同步 数据 库与共享的同步 数据库与共享的同步 数据库与共享的同步 数据库与共享的同步 数据库 与共享的同步 数据库与共享的同步 数据库与共享的同步 数据库与共享的同步 ; 变更捕捉 捕捉数据 资源 变更情况 。 数据转入 以固定间隔时轮询变更登记表,读取其中的 录并将这些约以固定间隔时轮询变更登记表, 读取其中的 录并将这些约以固定间隔时轮询变更登记表,读取其中的 录并将这些约格式 组成 XML 报文,存储到共享库的换出表中 ;3非结构化数据文件直接通过服务传输至交换中心 器,并有非结构化数据文件直接通过服
10、务传输至交换中心器,并有 智慧城市公共信息平台-平台接口与服务要求 4 分发非结构化数据文件。 数据交换路由 以固定时间隔轮询应用单位换入表,拆解 以固定时间隔轮询应用单位换入表,拆解 XML 报文,根据目标库自动分拣 报文,根据目标库自动分拣 ; 非结构化数据文件直接通过服务传输至交换中心 器,并有非结构化数据文件直接通过服 务传输至交换中心 器,并有分发非结构化数据文件。 数据转出 独立运行的进程, 以固定间隔时轮询交换库中的 入表,读取其以固定间隔时轮询交换库 中的 入表,读取其 XML 报文,并将数据按定制的格式同步到共享库中 。 非结构化数据文件描述信息存储在队列中,由各服务器根分
11、非结构化数据文件描述信息 存储在队列中,由各服务器根分 别从中心文件服务器获取所需数据。 交换管理程序 完成 数据交换审批流程、监控调度系统管理 数据交换审批流程、监控调度系统管理 数 据交换审批流程、监控调度系统管理 数据交换审批流程、监控调度系统管理 数据交换审 批流程、监控调度系统管理 数据交换审批流程、监控调度系统管理 数据交换审批流程、 监控调度系统管理 数据交换审批流程、监控调度系统管理 等功能一套 等功能一套 程序 , 部署于中心。 Web 服务 基于 webservice 技术开放的 服务接口,采用约定的 服务接口,采用约定的 XML 作为 交易数据接口, 提供给客户端调用。
12、WSDL Web 服务描述文件, 一个用来描述 一个用来描述 Web 服务和说明如何与 服务和说明 如何与 Web 服务通信的 服务通信的 XML 语言。为用户提供详细的接口说明 。 访问认证 公共信息平台提供用户认证 服务,由托管应系统的客端调于验公共信息平台提供用户认 证 服务,由托管应系统的客端调于验公共信息平台提供用户认证 服务,由托管应系统的 客端调于验用户是否合法; 应用单位 接入公共信息平台的机构单位。 主管 单位 公共 信息平台的管理单位 。 数据 中心 公共 信息平台 的组成部分, 是公共信息平台数据及应用系统存储的地方 。 智慧城市公共信息平台-平台接口与服务要求 5 4
13、接口服务概述 4.1 接口服务组成 信息资源目录服务包含三种接口,即信息资源基础服务接口、资源服务接口 (发现接口、资源接口)、信息资源管理服务接口。其中,基础接口是将资源服务 接口和管理接口中基础性的操作定义成一个公共接口。这 3 类接口实现了信息资 源的发现功能、检索功能和管理功能。4基础接口:提供会话管理功能和服务自描述功能,包含有目录服务初始化接 口、目录服务终止接口和服务自描述接口。 发现接口:提供信息资源元数据检索功能和信息资源元数据检索结果提取功 能,包含有目录检索接口以及目录检索结果提取接口。这些接口本身并不提供资 源,而是提供资源基本信息和如何去获得这些资源的元数据。 资源接
14、口:根据发现接口获得信息资源元数据,定位、查找资源具体内容的 接口,包含资源内容检索接口及资源内容结果提取接口。 管理接口:提供元数据管理的功能,包含信息资源元数据管理接口。 城市公共信息平台接口服务组成见图 1. 智慧城市公共信息平台 基础接口服务资源接口服务 管理接口服务 服务初始化认证授权服务终止发现服务资源服务 资源元数据新 增服务 资源元数据更 新服务 资源元数据删 除服务 资源目录检索 资源目录结果 提取 资源内容检索 资源内容结果 提取 图 1. 城市公共信息平台接口服务组成图 智慧城市公共信息平台-平台接口与服务要求 6 4.2 4.2 接口技术要求 接口技术要求 接口技术要求
15、 接口技术要求 接口技术要求 a) 提供基于 SOAP 协议的 web 服务接口 b) 支持跨语言、操作系统调用 智慧城市公共信息平台-平台接口与服务要求 7 5 总体 要求 5. 1 消息结构 每个交易消息 每个交易消息 (包括请求和应答 包括请求和应答 包括请求和应答 包括请 求和应答 )有一个是名字( 有一个是名字( 有一个是名字( 有一个是名字( Message Name Message Name) ,交易消息 ) ,交易消息 ) ,交易消息 以 XML 格式表达的,根据 格式表达的,根据 XML 的定义,每个 的定义,每个 XML 文件需要有特定的 Root Tag Root Tag
16、 (根 标记) ,在本 标记) ,在本 标记) ,在本 要求 中,用交易名称 中, 用交易名称 +请求类别作为根节点,如初始化接口的包 请求类别作为根节点,如初始化 接口的包 根节点为 initRequest ,而响应包的根节点为 ,而响应包的根节点为 initResponse 。根节点下之间放业 。根节点下之间放业 务接口数据。 5. 1.1 请求报文范例 55.1.2 响应报文范例 5.2 5.2 接口方式 接口采用 WebService 方式,接口协议使用 SOAP 协议,提供标准的 WSDL 文 件。 智慧城市公共信息平台-平台接口与服务要求 8 5.3 5.3 接口地址 公共信息目录
17、服务(以下简称)主要有三个 公共信息目录服务(以下简称)主要有三个 公共信息目录服务(以下简称)主要有三个 wsdl 地址,不同的 地址,不同的 wsdl 下 有不同的方法,文说明。这是根据 webservice 的 soap 协议开放出来的 协议开放出来的 wsdl 地址,第三方应用可以根据实际的部署服务器来使它。 1) 基础接口 WSDL 文件地址: http:/:/es/catalogbase?wsdl 目录服务初始化 initCatalogService 目录服务终止 stopCatalogService 2) 发现接口 WSDL 文件地址: http:/:/es/digcatalog
18、?wsdl 目录检索 queryCatalogList 目录检索结果提取 queryCatalogResult 3) 资源服务接口: http:/:/es/digresource?wsdl 资源检索 getResourceResultset 资源检索结果提取 getResourceResultDetail 4) 发现接口 WSDL 文件地址: http:/:/es/digcatalog?wsdl 资源元数据管理 metadataManage 5.4 5.4 使用说明 完成资源的检索与发现需要根据以下步骤来操作: 1) 第一步:初始化操作。调用基础接口的“目录服务初始化”获得一个会 话标识符以后
19、 每次调用接口都需要次标识符。 2) 第二步:查询公共信息目录操作。调用发现接口的“目录检索”组织好查询参数,发 起交易,获得查询结果。注:这里的查询结果只有返回命中的查询记录数。比如:返回值 是 100,那么表示有 100 条记录符合查询条件,这个时候需要发起“公共信息目录检索结 果提取”交易才能提取 智慧城市公共信息平台-平台接口与服务要求 9 查询的结果。如果发回值是 0,表示没有符合查询条件的记录。 3) 第三步:查询公共信息目录对应的资源。这里的操作也是和上面一样,调用“资源检 索”先要查询下是否有符合查询条件的资源。有资源记录的话,然后在调用“资源检索结 果提取”提取符合条件的资源
20、信息。 4) 第四步:假如调用接口结束后,可调用基础接口里的“目录服务终止”来释放会话标 识符资源信息。 智慧城市公共信息平台-平台接口与服务要求 10 6 业务接口 要求 6.1 6.1 基础接口 要求 6.1.1 目录服务初始化 公共信息目录服务初始化用于建立客户端与服务端的会话,所有其他服务都必须依赖会话。6会话的持续时间为 30 分钟,若会话持续 30 分钟没有活动,则会话自动终止。本次初始化 作用是客户端认证同时获取会话标识符,后续发起交易时需要传递该会话标识符。 1. 请求报文体 序号 元素名称 元素名称 约束 类型 长度 描述 取值说明 取值说明 1. protocolVersi
21、on protocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersionprotocolVersion protocolVersionprotocolVersionprotocolVersionprotocolVersion protocolVersion 可选 StringStringStringString String 50 客户端协议版本号 客户端协议实现的 客户端协议实现的 客户端协议实现的 客户端协议实现的 客户端协议 实现的 客户端协议实现的 客户端协议实现的 客户端协议实现的 版本号 2. id
22、Authentication idAuthentication idAuthentication idAuthenticationidAuthentication idAuthenticationidAuthenticationidAuthentication idAuthentication 必选 StringStringStringString String 50 用户名 用户名 用户名 /密 码 认证信息。包含用户 认证信息。包含用户 认证信息。包含用户 认证信息。包含用户 认 证信息。包含用户 认证信息。包含用户 身份标识及其密码。 身份标识及其密码。 身份 标识及其密码。 身份标识及
23、其密码。 身份标识及其密码。 格式“ 格式“ /” 3. implementationId implementationId implementationId implementationIdimplementationIdimplementationIdimplementationId implementationId implementationId 可选 StringStringStringString String 50 应用标识 应用标识 在公共信息平台用 在公共信息平台用 在公共信息平台用 在公共信息平台用 在公共信息 平台用 在公共信息平台用 在公共信息平台用 在公共信息平台用
24、户体系中注册的第 户 体系中注册的第 户体系中注册的第 户体系中注册的第 户体系中注册的第 户体系中注册 的第 户体系中注册的第 户体系中注册的第 三方应用编号 三方应用编号 三方应用编号 4. implementationName implementationName implementationName implementationNameimplementationNameimplementationNameimplementationName implementationName implementationName 可选 StringStringStringString String
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 智慧 城市 公共 信息 平台 接口 服务 要求
限制150内