一体化协同办公电子公文交换系统接入规范.docx
1
一体化协同办公电子公文交换系统接入规范
1范围
本文件规定了省政务部门电子公文交换系统的接入方式和标准接口。
本文件适用于省政务部门的各类电子公文系统接入电子公文交换系统,并进行数据交换。
2规范性引用文件
下列文件中的内容通过文中的规范性引用而构成本文件必不可少的条款。其中,注日期的引用文件,仅该日期对应的版本适用于本文件;不注日期的引用文件,其最新版本(包括所有的修改单)适用于本文件。
GB/T33477—2016党政机关电子公文标识规范
GB/T33479—2016党政机关电子公文交换接口规范GB/T33480—2016党政机关电子公文元数据规范
3术语和定义
下列术语和定义适用于本文件。3.1
电子公文交换系统
提供安全传输机制和统一的交换接口,实现电子公文跨系统交换的信息系统。
[来源:GB/T33482-2016,3.3]3.2
电子公文
以数字形式存储于磁盘、光盘等媒体,依赖计算机系统阅读、处理并可在通信网络上传输的公文。[来源:GB/T33476.1-2016,3.1]
4缩略语
下列缩略语适用于本文件。
XML:可扩展标记语言(extensiblemarkuplanguage)
5接入方式
接入系统以接口方式接入电子公文交换系统。
6接口
6.1概述
2
遵循GB/T33479—2016,电子公文交换系统以WebService方式提供接口。接入系统使用XML调用接口。
接入系统通过定时轮询接口获取公文及其状态变化信息,轮询间隔应不小于10分钟。6.2登录接口
登录接口见表1。
表1登录接口
接口名称
login
功能说明
验证用户合法性,并返回合法性结果,如合法返回sessionCode,否则返回空
请求参数
参数名
类型
必选
参数说明
loginId
String
Y
用户登录名
password
String
Y
用户登录密码
loginType
Int
Y
登录方式(0数据库验证;1动态密码验证;2LDAP验证)
ipAddress
String
Y
用户IP地址
返回值结果
参数名
类型
必选
返回结果说明
sessionCode
String
Y
1::登录失败;2:唯一标识字符串
6.3统一认证登录接口
统一认证登录接口见表2。
表2统一认证登录接口
接口名称
loginByToken
功能说明
河南省级平台统一认证接口,验证用户合法性,如合法返回sessionCode,否则返回空
请求参数
参数名
类型
必选
参数说明
clientId
String
Y
统一认证平台下发的应用Id
token
String
Y
对于统一认证平台里的用户token
3
表2统一认证登录接口(续)
返回值结果
参数名
类型
必选
返回结果说明
sessionCode
String
Y
1::登录失败;
2:唯一标识字符串;
6.4获取字段设置信息接口
获取字段设置信息接口见表3。
表3获取字段设置信息接口
接口名称
getExchangeFields
功能说明
获取电子公文交换系统字段设置信息
请求参数
参数名
类型
必选
参数说明
sessionCode
String
Y
用户唯一标识码
返回值结果
返回结果
类型
必选
返回结果说明
String
String
Y
此用户所在单位配置交换字段信息odoc_exchange_field
6.5公文发送接口
公文发送接口见表4。
表4公文发送接口
接口名称
sendData
功能说明
发送公文时调用,接入系统根据GB/T33480-2016生成公文数据,调用该接口将公文数据上传到电子公文交换平台,并返回发送状态、公文标识和反馈详情
请求参数
参数名
类型
必选
参数说明
appData
String
Y
公文数据,xml格式
sessionCode
String
Y
用户标识码
4
表4公文发送接口(续)
数据结构说明
参数名
类型
必选
参数说明
Document_Identifier
String
N
公文标识,发文的唯一标识,遵循GB/T33477—2016要求
Issuer
——
Y
发文单位
Identification_of_Document_Issuer
String
Y
发文单位唯一标识
Name_of_Document_Issuer
String
Y
发文单位名称
Receiver
Y
收文单位
Identification_of_Document_Receiver
String
Y
收文单位唯一标识
Name_of_Document_Receiver
String
Y
收文