智慧城市公共信息平台七接口与服务要求Word文档格式.docx
《智慧城市公共信息平台七接口与服务要求Word文档格式.docx》由会员分享，可在线阅读，更多相关《智慧城市公共信息平台七接口与服务要求Word文档格式.docx（153页珍藏版）》请在冰点文库上搜索。
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。
根节点下之间放业务接口数据。
请求报文范例
<
initRequest>
<
protocolVersion/>
idAuthentication/>
implementationId/>
implementationName/>
otherInfo/>
/initRequest>
响应报文范例
initResponse>
referenceId>
/referenceId>
protocolVersion>
/protocolVersion>
pubKey>
/pubKey>
result>
/result>
otherInfo>
/otherInfo>
/initResponse>
接口方式
接口采用WebService方式，接口协议使用SOAP协议，提供标准的WSDL文件。
接口地址
公共信息目录服务（以下简称目录服务）主要有三个wsdl地址，不同的wsdl下有不同的方法，下文有说明。
这是根据webservice的soap协议开放出来的wsdl地址，第三方应用可以根据实际的部署的服务器地址来使用它。
基础接口WSDL文件地址：
–initCatalogService
目录服务终止–stopCatalogService
发现接口WSDL文件地址：
–queryCatalogList
目录检索结果提取–queryCatalogResult
资源服务接口：
–getResourceResultset
资源检索结果提取–getResourceResultDetail
–metadataManage
使用说明
完成资源的检索与发现需要根据以下步骤来操作完成：
1）第一步：
初始化操作。
调用基础接口的“目录服务初始化”获得一个会话标识符以后每次调用接口都需要次标识符。
2）第二步：
查询公共信息目录操作。
调用发现接口的“目录检索”组织好查询参数，发起交易，获得查询结果。
注：
这里的查询结果只有返回命中的查询记录数。
比如：
返回值是100，那么表示有100条记录符合查询条件，这个时候需要发起“公共信息目录检索结果提取”交易才能提取查询的结果。
如果发回值是0，表示没有符合查询条件的记录。
3）第三步：
查询公共信息目录对应的资源。
这里的操作也是和上面一样，调用“资源检索”先要查询下是否有符合查询条件的资源。
有资源记录的话，然后在调用“资源检索结果提取”提取符合条件的资源信息。
4）第四步：
假如调用接口结束后，可调用基础接口里的“目录服务终止”来释放会话标识符资源信息。
6业务接口要求
基础接口要求
目录服务初始化
公共信息目录服务初始化用于建立客户端与服务端的会话，所有其他服务都必须依赖会话。
会话的持续时间为30分钟，若会话持续30分钟没有活动，则会话自动终止。
本次初始化作用是客户端认证同时获取会话标识符，后续发起交易时需要传递该会话标识符。
1.请求报文体
序号
元素名称
约束
类型
长度
描述
取值说明
1.
protocolVersion
可选
String
50
客户端协议版本号
客户端协议实现的版本号
2.
idAuthentication
必选
用户名/密码
认证信息。
包含用户身份标识及其密码。
格式“<
用户名>
/<
密码>
”
3.
implementationId
应用标识
在公共信息平台用户体系中注册的第三方应用编号
4.
implementationName
200
应用名称
在公共信息平台用户管系统中注册的第三方应用名称
5.
otherInfo
element
其他信息
备用
2.请求报文体模板
idAuthentication>
testApp/12456<
/idAuthentication>
implementationId>
1<
/implementationId>
implementationName>
测试应用<
/implementationName>
3.响应报文体
referenceId
会话标识
当验证成功时返回，否则设置为空
服务端协议版本号
服务端协议实现的版本号
result
Boolean
处理结果
服务器端用该参数表明是否接受建立会话的请求。
true表示建立会话成功，false表示建立会话失败，此时referenceId为空。
pubKey
64
加解密公钥
4.响应报文体模板
cde2db52-8cee-45f4-9cec-f8a68ebbad5c<
catalog<
true<
初始化服务成功<
目录服务终止
公共信息目录服务终止将结束服务端与客户端的会话，与会话相关的资源将被释放。
要终止的会话编号
closeReason
终止原因
2.求报文体模板
closeReason>
终止使用<
/closeReason>
认证授权
认证授权主要是公钥获取接口服务，用于根据客户端应用的请求，取出最新的加解密公钥并返回给客户端的过程。
公钥获取与其他接口不同，不需要用户验证，不需要会话标识。
调用客户端只有获取公钥后对用户认证信息进行加密才能完成其服务调用。
整个密码加解密的处理过程如下图所示：
图2..密码加解密的处理过程图
pubKeyRequest>
/pubKeyRequest>
8
公钥
用于加解密密码的密钥
opResult
操作结果
参见《表opResult属性表》之说明
pubKeyResponse>
pubkey>
/pubkey>
opResult>
<
opStatus>
/opStatus>
opRetCode>
code<
/opRetCode>
opRetMsg>
message<
/opRetMsg>
/opResult>
/pubKeyResponse>
发现接口要求
资源目录检索
公共信息目录检索是服务端根据客户端指定的检索条件，在服务器端从元数据库中检索并标识出匹配的元数据记录，并将元数据记录保存在结果集中的过程。
结果集的保存时间与会话标识一致，当会话结束后，响应的结果集将被同步删除。
replaceIndicator
结果集覆盖标志
true表示覆盖原来的查询结果，false表示保留原来的查询结果
resultSetID
指定的查询结果集名称
若存在同名的结果集，需要根据replaceIndicator判断是否需要覆盖结果集。
databaseNames
Element
要查询的元数据库名称列表
客户端指定的要查询的元数据库名称列表
query
客户端定制的检索语句
检索语句必须符合Type-1型，使用逆波兰表达式（RPN）作为检索语法，参见《附录EQUERY-RPN范例》
6.
preferredRecordSyntax
10
检索结果的编码方式
固定取值:
”XML”
7.
searchRequest>
f4973365-a9be-4f80-b5d8-a8b9c7949185<
replaceIndicator>
/replaceIndicator>
resultSetID>
highResult<
/resultSetID>
databaseNames>
BMDB<
/databaseNames>
preferredRecordSyntax>
XML<
/preferredRecordSyntax>
query>
根据国标的逆波兰表达式（RPN）组合的查询条件…具体规则参考<
/query>
/searchRequest>
resultCount
NumberString
20
符合条件的记录数
服务器端执行检索操作得到的命中记录数，检索失败设置为0
searchStatus
7
执行检索的执行结果
返回的检索状态信息，success表示检索成功，failture表示检索失败
searchResponse>
3720b175-7db7-408d-90cd-108e1f2ec887<
resultCount>
9<
/resultCount>
searchStatus>
success<
/searchStatus>
/searchResponse>
资源目录检索结果提取
目录检索结果由服务器端从结果集中提取并返回若干数据记录给客户端。
要抽取的结果集的标识
因为系统允许在抽取数据前进行多次检索，每次检索都可以指定不同的结果集名称，所以客户端必须指定要抽取的数据结果集标识
resultSetStartPoint
开始抽取的位置
客户端指定的从第几条记录开始抽取，序号从1开始
numberOfRecordsResquested
记录数
客户端指定的要抽取的记录数
elementSetName
结果集属性
参见表《表结果集属性》
提取结果的编码方式
presentRequest>
resultSetStartPoint>
0<
/resultSetStartPoint>
numberOfRecordsResquested>
30<
/numberOfRecordsResquested>
elementSetName>
genericElementSetName>
brief<
/genericElementSetName>
/elementSetName>
/presentRequest>
numberOfRecordsReturned
元数据数目
服务器端返回的元数据数目
presentStatus
提取状态
服务器端返回的提取状态。
success表示提取成功，failture表示提取失败
records
结果集
服务器返回的结果集,包含一个或多个singleRecord，详细描述参见《表singleRecord参数表》
presentResponse>
numberOfRecordsReturned>
/numberOfRecordsReturned>
presentStatus>
/presentStatus>
records>
结构化资源目录/非结构化资源目录<
/records>
/presentResponse>
资源服务接口要求
资源内容检索
资源检索是公共信息平台服务端根据客户端发送的请求信息，从共享数据库中读取符合条件的记录，并将查询结果集相关返回的过程。
注意，资源检索功能并不返回具体的结果集，结果集返回功能将由”资源检索结果提取”服务提供。
resId
资源标识符
6位字母/数字加”/”加1到23位数字
dataQuery
客户端定制的检索条件
参见《附录CQUERY-RES-DATA说明》–
dataSearchR
升级会员 