智慧城市公共信息平台七接口与服务要求.docx
《智慧城市公共信息平台七接口与服务要求.docx》由会员分享，可在线阅读，更多相关《智慧城市公共信息平台七接口与服务要求.docx（133页珍藏版）》请在冰豆网上搜索。
智慧城市公共信息平台七接口与服务要求
Documentnumber【SA80SAB-SAA9SYT-SAATC-SA6UT-SA18】
智慧城市公共信息平台七接口与服务要求
附件七
智慧城市公共信息平台
平台接口与服务要求
（试行）
中华人民共和国住房和城乡建设部建筑节能与科技司
二〇一三年三月
1范围
本要求是《智慧城市公共信息平台建设指南》建设要求系列之接口与服务要求。
本部分要求分两大部分描述平台接口要求，第一部分：
总体要求，总体要求描述消息的总体结构、接口访问方、接口地址、使用说明。
第二部分：
业务接口要求，具体描述每个业务应用服务接口的要求。
也就是每一个业务接口要求套在总体要求内。
只有使用业务接口要求+总体要求才能正常使用信息平台的应用服务来发现，查询，管理资源。
本部分适用于参与公共信息平台设计和研发人员，系统维护人员及要求接入公共信息平台的外部应用的开发人员。
2规范性引用文件
下列文件中的条款通过本部分的引用而成为本部分的条款。
凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本部分，鼓励根据本部分达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件，其最新版本适用于本部分。
GB/T政务信息资源目录体系第1部分：
总体框架；
GB/T政务信息资源目录体系第2部分：
技术要求；
GB/T政务信息资源目录体系第3部分：
核心元数据；
GB/T政务信息资源目录体系第4部分：
政务信息资源分类；
GB/T政务信息资源目录体系第5部分：
政务信息资源标识符编码方案；
本文<业务接口要求>引用《GB/T》中的附录A目录服务接口；
本文<附录A要求所涉及的结构表>引用《GB/T》中的附录A目录服务接口，及引用《GB/T》中的附录C政务信息资源目录服务属性集
本文<附录DQUERY-RPN范例>引用《GB/T》中的附录F检索串示例9.
3术语与定义
GB/T19710-2005中规定的与以下术语和定义适用于本部分。
目录
针对拥有共性的数据资源/文件资源进行分类，并且为该分类赋予唯一的资源标识符，该部分分类及分类描述的集合统称为资源目录，简称目录。
结构化资源
公共信息平台共享的二维库表结构数据，统称为结构化资源。
非结构化资源
公共信息平台共享的非二维库表结构数据，例如：
文本文件、视频、网络访问资源等统称为非结构化资源。
数据交换管理者
管理信息资源结点的机构。
交换内容提供者
提供信息资源交换内容的机构。
交换内容使用者
使用信息资源交换内容的机构。
前置环境
应用单位接入端系统软硬件及相关网络环境组成的应用单位前置系统的单元环境。
目录交换
按订阅模式进行目录资源数据的交换；
桥接系统
业务数据库与共享数据库的桥接器，保持交换数据库与共享数据库的同步；
变更捕捉
捕捉数据资源变更情况。
数据转入
以固定间隔时间轮询变更登记表，读取其中的记录，并将这些记录以约定的格式组成XML报文，存储到共享库的换出表中；
非结构化数据文件直接通过文件服务传输至交换中心文件服务器，并有中心分发非结构化数据文件。
数据交换路由
以固定时间间隔轮询应用单位换入表，拆解XML报文，根据目标库自动分拣；
非结构化数据文件直接通过文件服务传输至交换中心文件服务器，并有中心分发非结构化数据文件。
数据转出
独立运行的进程，以固定间隔时间轮询交换库中的换入表，读取其中的XML报文，并将数据按定制的格式同步到共享库中。
非结构化数据文件描述信息存储在信息队列中，由各服务器根据队列信息分别从中心文件服务器获取所需数据文件。
交换管理程序
完成数据交换审批流程、交换监控、交换调度、系统管理等功能一套程序，部署于中心。
Web服务
基于webservice技术开放的服务接口，采用约定的XML作为交易数据接口，提供给客户端调用。
WSDL
Web服务描述文件，一个用来描述Web服务和说明如何与Web服务通信的XML语言。
为用户提供详细的接口说明。
访问认证
公共信息平台提供用户认证服务，由托管应用系统的客户端调用，用于验证用户是否合法；
应用单位
接入公共信息平台的机构单位。
主管单位
公共信息平台的管理单位。
数据中心
公共信息平台的组成部分，是公共信息平台数据及应用系统数据存储的地方。
4接口服务概述
接口服务组成
信息资源目录服务包含三种接口，即信息资源基础服务接口、资源服务接口（发现接口、资源接口）、信息资源管理服务接口。
其中，基础接口是将资源服务接口和管理接口中基础性的操作定义成一个公共接口。
这3类接口实现了信息资源的发现功能、检索功能和管理功能。
基础接口：
提供会话管理功能和服务自描述功能，包含有目录服务初始化接口、目录服务终止接口和服务自描述接口。
发现接口：
提供信息资源元数据检索功能和信息资源元数据检索结果提取功能，包含有目录检索接口以及目录检索结果提取接口。
这些接口本身并不提供资源，而是提供资源基本信息和如何去获得这些资源的元数据。
资源接口：
根据发现接口获得信息资源元数据，定位、查找资源具体内容的接口，包含资源内容检索接口及资源内容结果提取接口。
管理接口：
提供元数据管理的功能，包含信息资源元数据管理接口。
城市公共信息平台接口服务组成见图1.
图1.城市公共信息平台接口服务组成图
接口技术要求
a）提供基于SOAP协议的web服务接口
b）支持跨语言、跨操作系统调用
5总体要求
消息结构
每个交易消息（包括请求和应答）有一个是名字（MessageName），交易消息以XML格式表达的，根据XML的定义，每个XML文件需要有特定的RootTag（根标记），在本要求中，用交易名称+请求类别作为根节点，如初始化接口的请求包根节点为initRequest，而响应包的根节点为initResponse。
根节点下之间放业务接口数据。
请求报文范例
响应报文范例
接口方式
接口采用WebService方式，接口协议使用SOAP协议，提供标准的WSDL文件。
接口地址
公共信息目录服务（以下简称目录服务）主要有三个wsdl地址，不同的wsdl下有不同的方法，下文有说明。
这是根据webservice的soap协议开放出来的wsdl地址，第三方应用可以根据实际的部署的服务器地址来使用它。
基础接口WSDL文件地址：
–initCatalogService
目录服务终止–stopCatalogService
发现接口WSDL文件地址：
–queryCatalogList
目录检索结果提取–queryCatalogResult
资源服务接口：
–getResourceResultset
资源检索结果提取–getResourceResultDetail
发现接口WSDL文件地址：
–metadataManage
使用说明
完成资源的检索与发现需要根据以下步骤来操作完成：
1）第一步：
初始化操作。
调用基础接口的“目录服务初始化”获得一个会话标识符以后每次调用接口都需要次标识符。
2）第二步：
查询公共信息目录操作。
调用发现接口的“目录检索”组织好查询参数，发起交易，获得查询结果。
注：
这里的查询结果只有返回命中的查询记录数。
比如：
返回值是100，那么表示有100条记录符合查询条件，这个时候需要发起“公共信息目录检索结果提取”交易才能提取查询的结果。
如果发回值是0，表示没有符合查询条件的记录。
3）第三步：
查询公共信息目录对应的资源。
这里的操作也是和上面一样，调用“资源检索”先要查询下是否有符合查询条件的资源。
有资源记录的话，然后在调用“资源检索结果提取”提取符合条件的资源信息。
4）第四步：
假如调用接口结束后，可调用基础接口里的“目录服务终止”来释放会话标识符资源信息。
6业务接口要求
基础接口要求
目录服务初始化
公共信息目录服务初始化用于建立客户端与服务端的会话，所有其他服务都必须依赖会话。
会话的持续时间为30分钟，若会话持续30分钟没有活动，则会话自动终止。
本次初始化作用是客户端认证同时获取会话标识符，后续发起交易时需要传递该会话标识符。
1.请求报文体
序号
元素名称
约束
类型
长度
描述
取值说明
1.
protocolVersion
可选
String
50
客户端协议版本号
客户端协议实现的版本号
2.
idAuthentication
必选
String
50
用户名/密码
认证信息。
包含用户身份标识及其密码。
格式“<用户名>/<密码>”
3.
implementationId
可选
String
50
应用标识
在公共信息平台用户体系中注册的第三方应用编号
4.
implementationName
可选
String
200
应用名称
在公共信息平台用户管系统中注册的第三方应用名称
5.
otherInfo
可选
element
其他信息
备用
2.请求报文体模板
testApp/12456
1
测试应用
3.响应报文体
序号
元素名称
约束
类型
长度
描述
取值说明
1.
referenceId
必选
String
50
会话标识
当验证成功时返回，否则设置为空
2.
protocolVersion
必选
String
50
服务端协议版本号
服务端协议实现的版本号
3.
result
必选
Boolean
处理结果
服务器端用该参数表明是否接受建立会话的请求。
true表示建立会话成功，false表示建立会话失败，此时referenceId为空。
4.
pubKey
必选
String
64
加解密公钥
5.
otherInfo
可选
element
其他信息
备用
4.响应报文体模板
cde2db52-8cee-45f4-9cec-f8a68ebbad5c
catalog
true
升级会员 