公共电子阅览室系统接口规范国家中心对接省分中心接口规范.docx
- 文档编号:25756147
- 上传时间:2023-06-12
- 格式:DOCX
- 页数:83
- 大小:236.16KB
公共电子阅览室系统接口规范国家中心对接省分中心接口规范.docx
《公共电子阅览室系统接口规范国家中心对接省分中心接口规范.docx》由会员分享,可在线阅读,更多相关《公共电子阅览室系统接口规范国家中心对接省分中心接口规范.docx(83页珍藏版)》请在冰豆网上搜索。
公共电子阅览室系统接口规范国家中心对接省分中心接口规范
公共电子阅览室系统接口规范
国家中心跟省分中心接口规范
1.0版
一.前言
为了规范全国公共电子阅览室信息的收集和统计,明确系统的数据交换要求,特制定《公共电子阅览室管理信息系统接口规范》(以下简称“本规范”)。
公共电子阅览室管理信息系统的数据交换接口要求是能保证各级之间的数据能安全、开放、独立、并行地交换。
在本规范中描述了公共电子阅览室管理信息系统数据交换接口的数据格式规范、连接规范。
二.引言
本规范旨在为全国文化信息资源共享工程各级公共电子阅览室管理信息系统制定一个统一的数据交换接口,达到平台无关,语言无关,便于与其它异构系统的集成和数据交换。
图中“443端口HTTPS”表示开发的服务端口,双向箭头线表示接口连接。
国家中心站点需开放基于HTTPSWebService的接口服务给省分中心站点连接,省分中心站点也需开放基于HTTPSWebService的接口服务给国家中心站点连接,详细接口列表请参见下一章“接口列表”,接口列表分两部分:
国家中心提供的接口列表和省分中心提供的接口列表。
“接口详细描述”章节分两部分:
1.接口使用的数据结构,说明了接口用到的字段、数据类型、字段说明等。
2.接口的调用原型,说明了调用接口时传入的参数和返回的数据结构。
三.适用范围
本规范适用于中国文化共享工程国家中心跟省分中心系统间的数据交换。
四.规范性引用文件
下列规范所包含的条文,通过在本规范中引用而构成为本规范的条文。
使用本规范时应考虑使用其最新版本的可能性。
GB/T2260-2007 中华人民共和国行政区划代码
GB/11643-1999 公民身份证号码
GB/T2659-2000 世界各国和地区名称代码
GB/T4658-2006学历代码
GB/T4762-1984政治面貌代码
GB/T3304-1991《中国各民族名称罗马字母拼写法和代码》
GB/T10114-2003县以下行政区划代码编码规则
GB/23l2-1980信息交换用汉字编码字符集基本集
WH/T16-2002互联网上网服务营业场所计算机经营管理信息系统技术规范
GB/T7408-2005数据和交换格式信息交换日期和时间表示法
GC-FG120368《全国文化信息资源共享工程公共电子阅览室管理信息系统软件开发及系统集成项目》项目技术方案接口及标准
《公共电子阅览室终端计算机配置标准》和《公共电子阅览室管理信息系统功能规范》
五.术语和定义
下列术语和定义适用于本规范。
5.1组件component
可复用的软件组成成分,可被用来构造其他软件。
它可以是被封装的对象类、类树、一些功能模块、软件框架(或体系结构)、文档、分析件、设计模式等。
5.2接口interface
对象所提供的一系列操作(方法)和属性。
5.3文档对象模型DocumentObjectModel
DOM,W3C制定的XML应用程序接口中。
它将XML文档表示成一个树形的结构。
DOM规定了一系列编程指令,允许应用程序多次访问并操作文档树的组件。
5.4TCP/IP
TCP/IP是用于互连各种网络的一组通信协议的总称,是一个开放式的协议集,遍布世界范围的Internet网络主要采用的就是该协议,它主要包括TCP、IP、ARP、RARP、UDP和SMTP等协议。
5.5公共电子阅览室
为了满足人民群众基本的网络文化需求,各级文化部门以公益性、基本性、均等性、便利性为原则,依托文化共享工程各级服务点、图书馆、文化馆,以及具备条件的工人文化宫、少年宫、妇女儿童活动中心、乡镇(街道)文化站、社区文化中心(村文化室)、学校、工业(产业)园区等,提供集互联网信息查询、文化共享工程信息资源服务、数字图书馆服务、培训、网络通讯、休闲娱乐等功能为一体的公共数字文化服务场所。
5.6公共电子阅览室管理信息系统
为了规范公共电子阅览室用户上机行为、管理和监控公共电子阅览室网络信息、掌握公共电子阅览室运行服务状况,采用信息技术手段实现各级业务需求的信息化管理系统。
5.7国家中心
是全国公共电子阅览室资源建设、技术支持、管理服务的中心,其职责由文化部全国文化信息资源建设。
5.8省级分中心
是本省公共电子阅览室技术支持、资源建设及调度、管理服务、人员培训的中心,其职责由文化共享工程省级分中心承担。
5.9地市级支中心
是本市公共电子阅览室技术支持、资源建设及调度、管理服务、人员培训的中心,其职责由文化共享工程地市级支中心承担。
5.10WebService
WebServices是由企业发布的完成其特定商务需求的在线应用服务,其他公司或应用软件能够通过Internet来访问并使用这项在线服务。
5.11WSDL
WebServicesDescriptionLanguage的缩写,是一个用来描述Web服务和说明如何与Web服务通信的XML语言。
为用户提供详细的接口说明书。
5.12SSL
安全套接层(SecureSocketsLayer,SSL)为Netscape所研发,采用公开密钥技术,保证两个应用间通信的保密性和可靠性,使客户与服务器应用之间的通信不被攻击者窃听。
可在服务器和客户机两端同时实现支持,目前已成为互联网上保密通讯的工业标准,现行Web浏览器亦普遍将Http和SSL相结合,从而实现安全通信。
5.13编码表
存储终端类型、电子阅览室类型等编码信息。
5.14黑名单
指根据国家法律法规所禁止或不适宜在公共电子阅览室中访问的网站或应用列表。
5.15推荐名单
指在公共电子阅览室中推荐用户访问的网站或应用列表。
5.16白名单
指在公共电子阅览室中仅允许访问的网站或应用列表。
六.安全机制
IP访问限制安全机制:
节点信息包含下级节点的IP地址,上级节点只接收指定IP地址的数据连接。
SSL安全套接层:
WebService接口服务部署在使用SSL安全机制的IIS服务器上,保证了数据的安全传输。
七.接口明细示意图
八.接口列表
根据所需要的功能和数据项,总体同步频率时间针对各个下级节点的数据传递要求做到可以自定义配置(可以设置同步时间[如每周、每日或每月的什么时间]或者同步周期[比如间隔5秒、1800秒等]),接口列表列出如下:
8.1国家中心提供的接口
国家中心需开放接口,被省分中心调用进行数据的传输。
接口名称
接口标识
接口说明
每条大小
频率
站点登录
PubERoom_StaLogin
可供省分中心登录认证
约50byte
连接时的第一个请求命令
下载编码表、黑白名单、抽查等信息
PubERoom_ParaDownload
用于国家中心到省分中心增量下发网址黑白名单,应用黑白名单,电子阅览室类别表,设备类别表,意见回复,资源导航服务器信息,抽查计划列表,意见回复列表,上级服务器列表,申请回复列表,资源栏目和导航资源信息等数据
约2KB
定时(无新数据时传输量微小)
节点信息
PubERoom_StationUpload
用于省分中心到国家中心增量上传各级节点信息
约1KB
定时
电子阅览室信息
PubERoom_ERoomUpload
用于省分中心到国家中心增量上传各级电子阅览室信息
约1KB
定时
工作管理人员信息
PubERoom_AdminUpload
用于省分中心到国家中心增量上传工作管理人员信息
约2KB
定时
电子阅览室上机规则
PubERoom_UseRuleUpload
用于省分中心到国家中心增量上传电子阅览室上机规则
约1KB
定时
电子阅览室设备信息
PubERoom_DeviceUpload
用于省分中心到国家中心增量上传电子阅览室设备信息
约1KB
实时
上传终端开机信息
PubERoom_DevStartUpload
用于省分中心到国家中心增量上传电子阅览室终端开机信息
50B
实时
上传终端关机信息
PubERoom_DevEndUpload
用于省分中心到国家中心增量上传电子阅览室终端关机信息
50B
实时
上传终端登录信息
PubERoom_DevLoginUpload
用于省分中心到国家中心增量上传电子阅览室终端登录信息
200B
实时
上传终端退出信息
PubERoom_DevLogoutUpload
用于省分中心到国家中心增量上传电子阅览室终端退出信息
50B
实时
上传使用记录
PubERoom_StaUploadRec
用于省分中心到国家中心发送使用记录
200B
定时
上传开关机记录
PubERoom_DevOpenUpload
用于省分中心到国家中心发送开关机记录
约80B
定时
上传报警信息
PubERoom_WarningUpload
用于省分中心到国家中心报警信息上传
约1KB
定时
上传即时通讯记录
PubERoom_IMRecUpload
用于省分中心到国家中心发送即时通讯记录
约1K
抽查
上传网址访问记录
PubERoom_RCNaviRecUpload
用于省分中心到国家中心发送网址访问记录
约1K
抽查
上传意见信息
PubERoom_CommentUpload
用于省分中心到国家中心发送意见表
约1K
定时
上传抽查执行结果
PubERoom_SpotCheckUpload
用于省分中心到国家中心发送抽查执行结果
约50B
实时
上传网址黑白名单
PubERoom_UploadBWURL
用于省分中心到国家中心增量上传网址黑白名单
约2KB
定时
上传程序黑白名单
PubERoom_UploadBWProgram
用于省分中心到国家中心增量上传程序黑白名单
约2KB
定时
上传资源信息
PubERoom_UploadRCNavi
用于省分中心到国家中心上传资源信息
约1KB
24小时,可配置
上传站点档案
PubERoom_StaArchivesUpload
用于省分中心到国家中心发送站点档案
约1K
定时
上传申请报告
PubERoom_RequestNotesUpload
用于省分中心到国家中心发送申请报告
约1K
实时
上传使用统计记录
PubERoom_StaUploadUseStat
用于省分中心到国家中心发送使用统计
约80B
定时
上传开关机统计
PubERoom_OpenStatUpload
用于省分中心到国家中心发送开关机统计
约80B
定时
上传报警信息统计
PubERoom_WarnStatUpload
用于省分中心到国家中心发送报警信息统计
约80B
定时
上传推荐网站访问统计
PubERoom_RCNaviStatUpload
用于省分中心到国家中心发送推荐网站访问统计
约1K
定时
上传即时通统计信息
PubERoom_IMStatUpload
用于省分中心到国家中心发送即时通统计统计
约1K
定时
回应截屏/控制等命令
PubERoom_RemoteCtrlRes
用于省分中心到国家中心回应国家中心的截屏/控制等命令,可跨级路由数据
约100B
如果是截屏需在加上图像文件大小。
实时
断开连接
Release
用于断开接口连接,释放网络连接资源
无
实时
8.2省分中心提供的接口
省分中心需开放接口,被国家中心调用进行数据的传输。
接口名称
接口标识
接口说明
每条大小
频率
站点登录
PubERoom_StaLogin
可供国家中心登录认证
约50byte
连接时的第一个请求命令
截屏/控制等命令
PubERoom_RemoteCtrlReq
用于国家中心到省分中心发送截屏/控制等命令,可跨级路由数据
约100B
实时
断开连接
Release
用于断开接口连接,释放网络连接资源
无
实时
九.接口提供方式
9.1提供WebService接口
在Web服务器上开放一个WebService接口供第三方调用。
附件PubERoom.wsdl为WebService的WSDL文件。
十.接口详细描述
WebService服务接口使用的是标准HTTPS端口443(TCP)或HTTP端口80。
10.1接口使用到的数据结构
在下列表中字段类型分两种uint、string,uint表示数值整型,string表示字符串型。
在“是否可以为空”一列中“否”表示不允许空值,“是”表示值是可选填的类型,可以为空。
按照《公共电子阅览室管理信息系统编码规范》终端编码、公共电子阅览室编码编码、各级站点编码包含了上级编码信息,比如:
终端编码为3308020011001,33为浙江省省级站点编码,3308为衢州市级站点编码,330802为柯城区站点编码,3308020011表示终端所在的公共阅览室编码。
10.1.1STALOGINREQ下级节点登录上级节点请求包
字段名称
字段类型
是否可以为空
描述
szStaSN
string
否
节点编号,由6位字符组成(公共电子阅览室管理信息系统编码规范)
szVersion
string
否
版本号当前版本为“1.0.20121218”
szKey
string
否
给配给各级节点登录的密钥(扩展功能)
10.1.2STALOGINRES下级节点登录上级节点返回包
字段名称
字段类型
是否可以为空
描述
szSessionID
string
否
SessionID会话ID,连接序列号
szMemo
string
否
备注
10.1.3UPSTATION各级节点信息结构
字段名称
字段类型
是否可以为空
描述
szStaSN
string
否
节点编号,由6位字符组成(公共电子阅览室管理信息系统编码规范)
szStaName
string
否
节点名称
szIP
string
否
站点服务器外网IP地址
dwStaLevel
uint
否
站点级别
如:
国家中心
省分中心
地市级支中心
县级支中心
具体参见编码表
dwType
uint
否
节点类型编码,具体参见编码表
szLocation
string
否
站点地址
szPostCode
string
否
邮政编码
szWebSite
string
否
网址
dwStatus
uint
否
站点状态
0:
未安装
1:
离线
2:
在线
0x100:
部署中
0x200:
试运行
0x400:
正式运行
0x800:
已撤销
0x1000:
已合并
szAdminDiv
string
否
所属行政区划编码
szAdminDivName
string
否
行政区划名称
szUpperSta
string
否
上级节点编号
dwCreateDate
uint
否
创建日期
dwDelDate
uint
否
删除日期
dwOpenTime
uint
否
上班时间,HHMM
dwCloseTime
uint
否
下班时间,HHMM
szCoordinate
string
否
地理坐标(经纬度)如
"123.12312,456.789"
szServerCfg
UPDEVICECONFIG[]
否
服务器配置表(包含了UPDEVICECONFIG结构的列表,可以含多条记录)
szDBCfg
UPDEVICECONFIG[]
否
存储配置表(包含了UPDEVICECONFIG结构的列表,可以含多条记录)
szNetCfg
UPDEVICECONFIG[]
否
网络配置表(包含了UPDEVICECONFIG结构的列表,可以含多条记录)
szSoftCfg
UPDEVICECONFIG[]
否
软件配置表(包含了UPDEVICECONFIG结构的列表,可以含多条记录)
szAccessModes
string
否
接入方式的文字描述
dwBandwidth
uint
否
网络带宽(单位为M)
dwTestBandwidth
uint
否
实测网络带宽(单位为M)
dwDelFlag
uint
否
删除标志
0:
表示未删除
1:
表示已删除
szMemo
string
否
备注
10.1.4UPDEVICECONFIG节点服务器、存储、网络、软件配置表
字段名称
字段类型
是否可以为空
描述
dwDevTypeSN
uint
否
设备类型编码
szBrand
string
否
品牌
szModel
string
否
型号
szSpecification
string
否
设备规格
szPurpose
string
否
用途说明
szIndicators
string
否
主要指标说明
dwPurchaseDate
uint
否
采购日期YYYYMMDD
dwStartUseDate
uint
否
投入使用日期YYYYMMDD
dwDevLife
uint
否
设备使用年限
szCPU
string
否
CPU规格型号
dwMemSize
uint
否
内存大小(M)
dwDiskSize
uint
否
硬盘大小(G)
dwOsVer
uint
否
操作系统版本(主版本*1000000+次版本*10000+产品类型*100+系统类型(32位或64位))
WindowsXP32位:
5010032
Windows764位:
6010064
szMemo
string
否
备注
dwDelFlag
uint
否
删除标志
0:
表示未删除
1:
表示已删除
10.1.5UPEROOM各级电子阅览室信息结构
字段名称
字段类型
是否可以为空
描述
szERoomSN
string
否
电子阅览室编号,由10位字符组成(公共电子阅览室管理信息系统编码规范)
szERoomName
string
否
电子阅览室名称
szIP
string
否
电子阅览室服务器外网IP地址
dwStaLevel
uint
否
站点级别
如:
国家中心
省分中心
地市级支中心
县级支中心
具体参见编码表
dwType
uint
否
站点类型
文化共享工程各级服务点:
1
图书馆:
2
文化馆:
3
以及具备条件的工人文化宫:
4
少年宫:
5
妇女儿童活动中心:
6
乡镇(街道)文化站:
7
社区文化中心(村文化室):
8
学校:
9
工业(产业)园区:
10
具体参见编码表
szLocation
string
否
阅览室地址
szPostCode
string
否
联系人邮政编码
szWebSite
string
否
网址
dwStatus
uint
否
站点状态
0:
未安装
1:
离线
2:
在线
0x100:
部署中
0x200:
试运行
0x400:
正式运行
0x800:
已撤销
0x1000:
已合并
szAdminDiv
string
否
所属行政区划编码
szAdminDivName
string
否
行政区划名称
szUpperSta
string
否
上级节点编号
dwCreateDate
uint
否
创建日期
dwDelDate
uint
否
删除日期
dwOpenTime
uint
否
上班时间,HHMM
dwCloseTime
uint
否
下班时间,HHMM
szCoordinate
string
否
地理坐标(经纬度)比如“123.456,72.1234”
szAccessModes
string
否
接入方式
dwBandwidth
uint
否
网络带宽(M为单位)
两种测法,算两种的平均值。
1.平时在上传数据时按数据量比个耗时算出平均网络带宽。
2.在晚上空闲时段(比如00:
00左右),在固定时间(比如10分钟)内发测试数据(比如站点或设备信息)测出网络带宽。
dwTestBandwidth
uint
否
实测网络带宽
dwERoomType
uint
否
阅览室类型编码(公共电子阅览室管理信息系统编码规范)
举例如
01文化共享工程公共电子阅览室
02文化系统内其他公共电子阅览室
03其他行业公共电子阅览室
dwRoomArea
uint
否
房间面积(平米)
szDescription
string
否
电子阅览室信息描述
dwDelFlag
uint
否
删除标志
0:
表示未删除
1:
表示已删除
szMemo
string
否
备注
10.1.6DOWNLOADREQ下载上级节点的各种信息参数
字段名称
字段类型
是否可以为空
描述
dwChgFlag
uint
否
本地保存的修改更新标志,此内容值是上次上级节点返回的值,第一次调用时使用0.
10.1.7DOWNLOADINFO下载上级节点的各种信息
字段名称
字段类型
是否可以为空
描述
dwChgFlag
uint
否
本地保存的修改更新标志
10.1.8BWURL网址黑白名单
字段名称
字段类型
是否可以为空
描述
dwSN
uint
否
名单编号
dwType
uint
否
名单类别编码,(预留,当前赋0值)
szURL
string
否
URL(支持通配符),长度64字节。
szName
string
否
网站名称
dwForAges
uint
否
适用年龄段(格式FFTT,举例0713表示7-13周岁)
dwResourseType
uint
否
资源类别编码(公共电子阅览室管理信息系统编码规范)
szOwnerName
string
否
资源所属者名称
dwOwnerNation
uint
否
资源所属国家(标准编码)
szIP
string
否
IP地址
dwEffectiveDate
uint
否
生效日期YYYYMMDD
szFromStaSN
string
否
名单的来源(站点编号)比如来自浙江,则是330000
dwStatus
uint
否
状态
无效:
0(表示这条网址在名单中无效)
未审查:
1(表示该条网址并未经过审查)
已审查:
2(表示经过审查)
向上级节点推荐:
0x10000
推荐名单未上传:
0x20000
用于各节点向上级推荐名单,作为审核是否通过的状态标志
szAdminN
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 公共 电子 阅览室 系统 接口 规范 国家 中心 对接
![提示](https://static.bdocx.com/images/bang_tan.gif)