朗读
各市、县(市、区)档案局,省直各单位:
为服务“最多跑一次”改革,做好各级各部门政务办事系统与电子文件管理统一平台的技术对接,实现全省政务事项电子文件的应归尽归和信息整合共享,我局研究制定了《政务服务网电子档案数据和信息交换接口技术规范V1.0(试行)》(可从浙江档案网下载其电子版本),现印发给你们,请结合实际遵照执行。
浙江省档案局
2018年6月22日
政务服务网电子档案数据和信息交换接口技术规范V1.0(试行)
目 录
一. 主要参考文件 .................................................. 7
二. 交换接口概述 .................................................. 7
2.1. 适用范围 .................................................... 7
2.2. 面向对象 .................................................... 8
2.3. 接口实现方式 ................................................ 8
2.4. 交换接口描述 ................................................ 8
2.4.1. 数据交换方式的接口调用过程 ................................ 9
2.4.2. 信息交换方式的接口调用过程 ................................ 10
2.5. 数据上传存储要求 ............................................ 11
三. 交换平台部署图及接口调用流程图 ................................ 12
四. 接口详情 ...................................................... 14
4.1数据交换方式的接口 ............................................. 14
4.1.1与发送方相关 ................................................. 14
4.1.1.1供发送方调用 ............................................... 14
4.1.1.1.1 归档数据上传接口(由交换平台实现) ...................... 14
4.1.1.1.1.1 接口说明 .............................................. 14
4.1.1.1.1.2 接口部署 ............................................. 14
4.1.1.1.1.3 接口参数 ............................................. 14
4.1.1.1.1.4 示例数据 ............................................. 15
4.1.1.1.1.5 返回结果 ............................................. 17
4.1.1.1.2 获取数据交换归档检测结果接口(由交换平台实现) .......... 17
4.1.1.1.2.1 接口说明 ............................................. 17
4.1.1.1.2.2 接口部署 ............................................. 17
4.1.1.1.2.3 接口参数 ............................................. 17
4.1.1.1.2.4 示例数据 ............................................. 18
4.1.1.1.2.5 返回结果 .............................................. 18
4.1.1.2由发送方提供 ............................................... 18
4.1.1.2.1 获取归档检测结果回调接口(由发送方实现) ................ 18
4.1.1.2.1.1 接口说明 ............................................. 18
4.1.1.2.1.2 接口部署示例 ......................................... 18
4.1.1.2.1.3 接口参数 ............................................. 19
4.1.1.2.1.4 示例数据 ............................................. 19
4.1.1.2.1.5 返回结果 ............................................. 19
4.1.1.2.2 获取自检结果回调接口(由发送方实现) .................... 20
4.1.1.2.2.1 接口说明 ............................................. 20
4.1.1.2.2.2 接口部署示例 ......................................... 20
4.1.1.2.2.3 接口参数 ............................................. 20
4.1.1.2.2.4 示例数据 ............................................. 20
4.1.1.2.2.5 返回结果 ............................................. 21
4.1.2与接收方相关 ................................................. 21
4.1.2.1供接收方调用 ............................................... 21
4.1.2.1.1 获取归档数据接口(由交换平台实现) ...................... 21
4.1.2.1.1.1 接口说明 ............................................. 21
4.1.2.1.1.2 接口部署 ............................................. 21
4.1.2.1.1.3 接口参数 ............................................. 22
4.1.2.1.1.4 示例数据 ............................................. 22
4.1.2.1.1.5 返回结果 ............................................. 22
4.1.2.1.2 反馈数据交换四性检测接口(由交换平台实现) .............. 23
4.1.2.1.2.1 接口说明 ............................................. 23
4.1.2.1.2.2 接口部署 ............................................. 23
4.1.2.1.2.3 接口参数 ............................................. 23
4.1.2.1.2.4 示例数据 ............................................. 24
4.1.2.1.2.5 返回结果 ............................................. 24
4.1.2.2由接收方提供 ............................................... 24
4.1.2.2.1 获取归档数据回调接口(由接收方实现) .................... 24
4.1.2.2.1.1 接口说明 ............................................. 24
4.1.2.2.1.2 接口部署 ............................................. 25
4.1.2.2.1.3 接口参数 ............................................. 25
4.1.2.2.1.4 示例数据 ............................................. 25
4.1.2.2.1.5 返回结果 ............................................. 26
4.2信息交换方式的接口 ............................................ 26
4.2.1与发送方相关 ................................................. 26
4.2.1.1供发送方调用 ............................................... 26
4.2.1.1.1 归档元数据上传接口(由交换平台实现) .................... 26
4.2.1.1.1.1 接口说明 ............................................. 26
4.2.1.1.1.2 接口部署 ............................................. 27
4.2.1.1.1.3 接口参数 ............................................. 27
4.2.1.1.1.4 示例数据 ............................................. 28
4.2.1.1.1.5 返回结果 ............................................. 29
4.2.1.1.2 获取信息交换归档检测结果接口(由交换平台实现)........... 29
4.2.1.1.2.1 接口说明 ............................................. 29
4.2.1.1.2.2 接口部署 ............................................. 29
4.2.1.1.2.3 接口参数 ............................................. 29
4.2.1.1.2.4 示例数据 ............................................. 30
4.2.1.1.2.5 返回结果 ............................................. 30
4.2.1.2由发送方提供 ............................................... 30
4.2.1.2.1 获取归档检测结果回调接口(同4.1.1.2.1).................. 30
同4.1.1.2.1,具体略。 ............................................. 30
4.2.2与接收方相关 ................................................. 30
4.2.2.1供接收方调用 ............................................... 30
4.2.2.1.1 反馈接收结果接口(由交换平台实现) ...................... 30
4.2.2.1.1.1 接口说明 ............................................. 30
4.2.2.1.1.2 接口部署 ............................................. 31
4.2.2.1.1.3 接口参数 ............................................. 31
4.2.2.1.1.4 示例数据 ............................................. 32
4.2.2.1.1.5 返回结果 ............................................. 32
4.2.2.1.2 反馈信息交换四性检测接口(由交换平台实现) .............. 32
4.2.2.1.2.1 接口说明 ............................................. 32
4.2.2.1.2.2 接口部署 ............................................. 33
4.2.2.1.2.3 接口参数 ............................................. 33
4.2.2.1.2.4 示例数据 ............................................. 34
4.2.2.1.2.5 返回结果 ............................................. 34
五. 其他接口 ...................................................... 34
5.1归档元数据省级上传接口(由省交换平台实现) ..................... 34
5.1.1 接口说明 ................................................... 34
5.1.2 接口参数 ................................................... 35
5.1.3 “基本信息描述.xml”示例 ................................... 35
一. 主要参考文件
《浙江政务服务网电子文件归档移交业务需求与技术规范(试行)》、《政务办事“最多跑一次”工作规范 第3部分:政务服务网电子文件归档数据规范》(DB33/T2036.3-2017)。
二. 交换接口概述
2.1. 适用范围
本规范规定了浙江政务服务网等统建政务系统与各行业系统、各单位自建政务系统(简称“政务系统”),通过全省分级部署的“政务服务网电子档案数据交换平台”(简称“交换平台”),向本级“电子文件归档处理系统”(简称“归档处理系统”)发送存档信息包及接收反馈信息的接口方式、基本要素、规则和范例等。本规范主要适用于政务系统、交换平台、归档处理系统的开发方、建设方和其它相关方使用,并作为各方实现存档信息包交换和信息反馈等接口的技术规范。其他办事系统、归档管理系统通过交换平台实现存档信息包数据交换和信息反馈等接口,可参照执行。 交换平台是政务系统预归档模块与归档处理系统的对接桥梁,后两者均按照本规范与交换平台实现技术对接。此外,交换平台还统一管理接口资源,控制接口访问权限和策略,监控和分析接口调用结果,对全省政务电子文件归档情况进行统计汇总和信息整合共享。
2.2. 面向对象
本规范的主体对象是交换平台。相对于交换平台,政务系统作为发送方,而归档处理系统作为接收方。
2.3. 接口实现方式
本规范的接口发布及调用均采用WebService标准方式,并由交换平台以接口注册方式提供接口调用和进行权限控制。根据接口的发布及调用对象,本规范接口可分为两类:平台接口、回调接口。平台接口由交换平台实现,并由发送方或接收方进行调用;回调接口由发送方或接收方实现,并由交换平台进行实时触发调用。 本规范的文件传输采取FTP或OSS(云存储服务)方式。本规范所有接口均未在内部实现数据文件传输功能。对于需传输数据文件的接口调用,先由接口调用方以FTP或OSS方式将数据文件上传到交换存储服务器,再通过调用该接口,将数据文件的网络访问路径(或子路径)以参数方式传递给接口实现方进行下载。 本规范的接口参数类型默认均为字符串(String),其内容和格式要求(如“归档时间”等)详见约束性条件与参数说明。
2.4. 交换接口描述
“政务服务网电子档案数据交换平台”部署在政务云平台上,并提供数据交换、信息交换两种交换方式。
数据交换方式:指发送方、接收方通过交换平台的接口调用,以FTP或OSS方式进行存档信息包的上传、下载和检测反馈。 信息交换方式:指在发送方与接收方之间已直接建立接口和传输通道,交换平台不参与数据传输过程,只对发送方与接收方提交的归档完成状态、检测结果及元数据进行接收、管理和统计。 以上两种交换方式的主要调用流程如下:
2.4.1. 数据交换方式的接口调用过程
(1)发送方将存档信息包上传到交换存储服务器(FTP或OSS云存储)后,主动调用交换平台的“归档数据上传接口(dataSave)”,将存档信息包相关参数信息(如档号、数据路径等)提交给交换平台。
此后,发送方可随时调用交换平台的“获取数据交换归档检测结果接口(receiveDataArchiveResult)”,以获取存档信息包的检测完成状态或检测结果。
(2)交换平台执行归档数据上传接口,根据接口参数对发送方上传的存档信息包信息进行存储。
(3)交换平台定时任务发起,对发送方上传的数据包进行下载、技术验证和处理,实时调用发送方的“获取自检结果回调接口(receiveSelfResultCallback)”,将自检结果实时反馈发送方。如自检通过,将实时调用接收方的“获取归档数据回调接口(newDataCallback)”。
(4)接收方执行该回调接口,根据接口参数对交换存储服务器上的存档信息包进行下载、四性检测后,实时调用交换平台的“反馈数据交换四性检测接口(zjDataInfoBack)”,将四性检测结果反馈给交换平台。
此时,如归档数据在下载过程中发生错误,接收方可随时调用交换平台的“获取归档数据接口(fetchData)”,一次性获取未成功下载的归档信息列表。
(5)交换平台执行“反馈数据交换四性检测接口(zjDataInfoBack)”,并根据接口注册参数,实时调用发送方的“获取归档检测结果回调接口(receiveArchiveResultCallback)”,将四性检测结果实时反馈发送方;对于四性检测合格的存档信息包,将解析包内的元数据(“基本信息描述.xml”),本地保存并上传至省交换平台进行汇集和统计。 省交换平台收到存档信息包的元数据后,将实时调用浙江档案服务网的“归档元数据省级上传接口(getDataFromJhpt)”,将可以开放共享的归档信息发布到浙江档案服务网。
2.4.2. 信息交换方式的接口调用过程
(1)发送方在与接收方直接建立数据对接通道并完成存档信息包传输后,实时调用交换平台的“归档元数据上传接口(infoSave)”,将相关参数信息(如档号等)提交给交换平台,并上传存档信息包内的元数据(“基本信息描述.xml”)到交换存储服务器。交换平台将根据参数信息实时记录推送状态。
此后,发送方也可主动调用交换平台的“获取信息交换归档检测结果接口(receiveMesArchiveResult)”,随时获取存档信息包的检测完成状态或检测结果。
(2)接收方在完成存档信息包的接收后,实时调用交换平台的“反馈接收结果接口(saveResultBack)”,将相关接收参数信息(如接收状态、档号等)提交给交换平台。交换平台将根据参数信息实时记录和更新接收状态。
(3)接收方在完成归档数据的四性检测后,实时调用交换平台的“反馈信息交换四性检测接口(zjMesInfoBack)”,将四性检测的结果信息反馈给交换平台。
(4)交换平台执行“反馈信息交换四性检测接口(zjMesInfoBack)”,根据接口注册参数,实时调用发送方的“获取归档检测结果回调接口(receiveArchiveResultCallback)”,将四性检测结果实时反馈发送方;对于四性检测合格的存档信息包,将解析包内的元数据(“基本信息描述.xml”),并上传到省交换平台进行汇集和统计。
省交换平台在接收到元数据后,将实时调用浙江档案服务网的“归档元数据省级上传接口(getDataFromJhpt )”,将可以开放共享的归档信息发布到浙江档案服务网。
2.5. 数据上传存储要求
为确保文件传输时数据存储的规范性、安全性和高效性,所有通过FTP或OSS方式上传的存档信息包应按照统一存储组织方式进行上传。各权力事项的存档信息包应上传到统一指定的虚拟存储路径下,并按照以下规则生成规范路径进行保存:
地区-单位-信息系统。对于交换量大的单位可在规范路径上进一步自定义子路径,如:地区-单位-信息系统-权力事项类型-权力事项。
三. 交换平台部署图及接口调用流程图
下图为数据交换平台部署图:
对于政务服务网采取市级集中部署的地区,建议采取省市二级部署、省市县三级应用的模式;对于政务服务网采取市、县(市、区)分级部署的地区,可采取省市县三级部署和三级应用。为便于推广和维护,建议有条件的设区市统一申请云资源,部署本级及所属县(市、区)的交换平台。
下图为数据交换方式的接口调用流程示意图:
下图为信息交换方式的接口调用流程示意图:
四. 接口详情
4.1数据交换方式的接口
4.1.1与发送方相关
4.1.1.1供发送方调用
4.1.1.1.1 归档数据上传接口
4.1.1.1.1.1 接口说明
本接口由交换平台实现,适用于数据交换方式。本接口一般由发送方主动调用,即发送方在权利运行系统办结并按照《政务办事“最多跑一次”工作规范 第3部分:政务服务网电子文件归档数据规范》(DB33/T 2036.3-2017,简称“规范”)归档打包后,先将存档信息包以FTP或OSS方式上传到云存储,再调用本接口完成归档数据上传。本接口执行时,交换平台将对上传的存档信息包相关参数信息进行记录,并对存档信息包进行必要技术检测。
4.1.1.1.1.2 接口部署
Webservice接口访问地址,示例如下:
http://IP:8080/was/lwservices/DataSave?wsdl (IP地址以实际部署为准)
4.1.1.1.1.3 接口参数
方法名 |
dataSave |
|
参数名 |
约束性 |
参数说明 |
file_num |
不允许为空 |
档号 |
data_name |
不允许为空 |
数据名称 |
time_stamp |
允许空值 |
时间戳 |
send_time |
允许空值 |
归档时间 (yyyy-MM-dd HH:mm:ss) |
data_path |
不允许为空 |
数据包的存放路径(数据包的OSS云存储路径或FTP子路径) |
send_person |
允许空值 |
归档人 |
data_size |
不允许为空 |
数据包大小 |
data_type |
不允许为空 |
数据包格式 |
sxbm |
不允许为空 |
事项编码 |
sxbbh |
不允许为空 |
事项版本号 |
secret |
不允许为空 |
密钥 |
qym |
不允许为空 |
区域码 |
dept_code |
不允许为空 |
部门编码 |
md5 |
不允许为空 |
Md5值 |
arg |
不允许为空 |
1.md5 2.时间戳 3.电子签章 |
sxmc |
不允许为空 |
事项名称 |
speci_system |
不允许为空 |
具体系统 |
xtbm |
不允许为空 |
系统编码 |
code |
不允许为空 |
类型树编码 |
is_share |
不允许为空 |
是否共享资源 |
返回值 |
JSON格式 |
返回JSON格式的接口执行与技术检测结果,如{"result":"1","mes":"执行成功"} |
4.1.1.1.1.4 示例数据
参数名 |
参数说明 |
示例数据 |
file_num |
档号 |
33000022-01-00313-002-2016-30年-0000019 |
data_name |
数据名称 |
33000022-01-00313-002-2016-30年-0000019 |
time_stamp |
时间戳 |
001003016/201612/9A874CDB524746B920995E12C44C1F5C/33000022-01-00313-002-2016-30年-0000019.tsa |
send_time |
归档时间 |
2017-02-21 17:21:30 |
data_path |
数据包的存放路径 |
001003016/201612/9A874CDB524746B920995E12C44C1F5C/33000022-01-00313-002-2016-30年-0000019.zip |
send_person |
归档人 |
杭州某公司 |
data_size |
数据包大小 |
20M |
data_type |
数据包格式 |
zip |
sxbm |
事项编码 |
33000005 |
sxbbh |
事项版本号 |
V1.3 |
secret |
密钥 |
811D0CB79377016053313C022B8F813D |
qym |
区域码 |
330100 |
dept_code |
部门编码 |
001008001026074 |
md5 |
Md5值 |
5A236F48C67CFDDE52EE36256C5F208F |
arg |
1. md5 2. 时间戳 3.电子签章 |
1 |
sxmc |
事项名称 |
申报人员资格认可 |
speci_system |
具体系统 |
192.168.1.1 |
xtbm |
系统编码 |
33010001 |
code |
类型树编码 |
行政许可 |
is_share |
是否共享资源 |
是 |
4.1.1.1.1.5 返回结果
以JSON格式返回接口执行结果和执行信息,格式定义如下:
Return :{"result":"0","mes":"你没有权限调用这个接口"} ; |
4.1.1.1.2 获取数据交换归档检测结果接口
4.1.1.1.2.1 接口说明
本接口由交换平台实现,适用于数据交换方式。本接口一般由发送方主动调用,以从交换平台获取存档信息包的检测状态及结果信息。
4.1.1.1.2.2 接口部署
Webservice接口访问地址,示例如下http://IP:8080/was/lwservices/ReceiveDataArchiveResult?wsdl (IP地址以实际部署为准)
4.1.1.1.2.3 接口参数
方法名 |
receiveDataArchiveResult |
|
参数名 |
约束性 |
参数说明 |
secret |
不允许空值 |
密钥 |
qym |
不允许空值 |
区域码 |
dept_code |
不允许空值 |
部门编码 |
xtbm |
不允许空值 |
系统编码 |
file_num |
不允许空值 |
档号 |
返回值 |
JSON格式 |
返回JSON格式的四性检测结果 |
4.1.1.1.2.4 示例数据
参数名 |
参数说明 |
示例数据 |
secret |
密钥 |
811D0CB79377016053313C022B8F813D |
qym |
区域码 |
330100 |
dept_code |
部门编码 |
001008001026074 |
xtbm |
系统编码 |
33010001 |
file_num |
档号 |
33000019-01-00190-024-2017-5年-0000171 |
4.1.1.1.2.4 返回结果
以JSON格式返回四性检测结果信息,格式定义如下:
Return :{"result":"1","message":"合格"} ; |
4.1.1.2由发送方提供
4.1.1.2.1 获取归档检测结果回调接口
4.1.1.2.1.1 接口说明
本接口由发送方实现,适用于数据交换或信息交换方式。本接口一般由交换平台实时调用,即交换平台收到或更新存档信息包的四性检测结果时,将同步调用发送方的本回调接口,并将检测结果等参数信息实时反馈给发送方。
4.1.1.2.1.2 接口部署示例
Webservice接口访问地址,示例如下: http://IP:8080/archiveServices/ReceiveArchiveResultCallback?wsdl(IP地址、端口及虚拟子路径以实际部署为准)
4.1.1.2.1.3 接口参数
方法名 |
receiveArchiveResultCallback |
|
参数名 |
约束性 |
参数说明 |
file_num |
不允许空值 |
档号 |
dept_code |
不允许空值 |
部门ID |
result |
采用JSON格式 |
四性检测结果 |
返回值 |
字符串1或0 |
1:成功;0:失败 |
4.1.1.2.1.4 示例数据
参数名 |
参数说明 |
示例数据 |
file_num |
档号 |
33000019-01-00190-024-2017-5年-0000171 |
dept_code |
部门ID |
001008001026074 |
result |
归档检测结果 |
{"result":"true","mes":"合格"} |
4.1.1.2.1.5 返回结果
以String字符串格式返回结果数据1或0,格式定义如下:
Return :{"result":"1","message":"合格"} ; |
4.1.1.2.2 获取自检结果回调接口
4.1.1.2.2.1 接口说明
本接口由发送方实现,适用于数据交换方式。本接口一般由交换平台实时调用,即交换平台收到或更新存档信息包进行自检操作时,将同步调用发送方的本回调接口,并将检测结果等参数信息实时反馈给发送方。
4.1.1.2.2.2 接口部署示例
Webservice接口访问地址,示例如下: http://IP:8080/archiveServices/ReceiveSelfResultCallback?wsdl(IP地址、端口及虚拟子路径以实际部署为准)
4.1.1.2.2.3 接口参数
方法名 |
receiveSelfResultCallback |
|
参数名 |
约束性 |
参数说明 |
file_num |
不允许空值 |
档号 |
dept_code |
不允许空值 |
部门ID |
result |
采用JSON格式 |
自检检测结果 |
返回值 |
字符串1或0 |
1:成功;0:失败 |
4.1.1.2.2.4 示例数据
参数名 |
参数说明 |
示例数据 |
file_num |
档号 |
33000019-01-00190-024-2017-5年-0000171 |
dept_code |
部门ID |
001008001026074 |
result |
自检检测结果 |
{"result":"true","mes":"合格"} |
4.1.1.2.2.5 返回结果
以String字符串格式返回结果数据1或0,格式定义如下:
Return:"1"; |
4.1.2与接收方相关
4.1.2.1供接收方调用
4.1.2.1.1 获取归档数据接口
4.1.2.1.1.1 接口说明
本接口由交换平台实现,适用于数据交换方式。本接口一般由接收方主动调用,通过指定地区编码、部门编码、系统编号等参数,以从交换平台获取所有未成功下载的归档信息集合。 本接口执行时,交换平台将提取符合条件的JSON数据信息集合并反馈给接收方。
4.1.2.1.1.2 接口部署
Webservice接口访问地址,示例如下: http://IP:8080/was/lwservices/FetchData?wsdl(IP地址以实际部署为准)
4.1.2.1.1.3 接口参数
方法名 |
fetchData |
|
参数名 |
约束性 |
参数说明 |
area_code |
不允许为空 |
地区编码 |
is_repeat |
不允许为空 |
是否可重复(0 不重复;1 重复) |
secret |
不允许为空 |
密钥 |
qym |
不允许为空 |
区域码 |
dept_code |
不允许为空 |
部门编码 |
xtbm |
不允许为空 |
系统编码 |
返回值 |
JSON集合格式 |
返回未成功下载的归档信息集合 |
4.1.2.1.1.4 示例数据
参数名 |
参数说明 |
示例数据 |
area_code |
地区编码 |
330100 |
is_repeat |
是否可重复 |
0 |
secret |
密钥 |
811D0CB79377016053313C022B8F813D |
qym |
区域码 |
330100 |
dept_code |
部门编码 |
001008001026074 |
xtbm |
系统编码 |
33010001 |
4.1.2.1.1.5 返回结果
以JSON集合格式返回批量结果数据,格式定义如下:
- 上一篇:关于核定墩头客运码头西侧停车场收费标准的批复
- 下一篇:中华人民共和国民法总则