公共电子阅览室系统接口规范-国家中心对接省分中心接口规范

公共电子阅览室系统接口规范
国家中心跟省分中心接口规范
1.0版
目录
公共电子阅览室系统接口规范 (1)
国家中心跟省分中心接口规范 (1)
目录 (i)
一. 前言 (1)
二.引言 (2)
三．适用范围 (3)
四. 规范性引用文件 (3)
五. 术语和定义 (4)
5.1 组件component (4)
5.2 接口interface (4)
5.3 文档对象模型Document Object Model (4)
5.4 TCP/IP (4)
5.5 公共电子阅览室 (5)
5.6 公共电子阅览室管理信息系统 (5)
5.7 国家中心 (5)
5.8 省级分中心 (5)
5.9 地市级支中心 (5)
5.10 WebService (6)
5.11 WSDL (6)
5.12 SSL (6)
5.13 编码表 (6)
5.14 黑名单 (6)
5.15 推荐名单 (6)
5.16 白名单 (7)
六．安全机制 (7)
七．接口明细示意图 (8)
八．接口列表 (10)
8.1国家中心提供的接口 (10)
8.2省分中心提供的接口 (15)
九．接口提供方式 (16)
9.1 提供WebService接口 (16)
十．接口详细描述 (16)
10.1 接口使用到的数据结构 (16)
10.2 接口详细描述和定义 (53)
十一．接口调用示例 (66)
11.1 C#调用示例 (66)
11.2 JA V A调用示例 (67)
一. 前言
为了规范全国公共电子阅览室信息的收集和统计，明确系统的数据交换要求，特制定《公共电子阅览室管理信息系统接口规范》（以下简称“本规范”）。

公共电子阅览室管理信息系统的数据交换接口要求是能保证各级之间的数据能安全、开放、独立、并行地交换。

在本规范中描述了公共电子阅览室管理信息系统数据交换接口的数据格式规范、连接规范。

二.引言
本规范旨在为全国文化信息资源共享工程各级公共电子阅览室管理信息系统制定一个统一的数据交换接口，达到平台无关，语言无关，便于与其它异构系统的集成和数据交换。

地级市对接县分中心接口，详细接口列表见《地级市对接县分中心接口规范》文档中的“接口列表”章节。

当阅览室存在现有异构系统时遵循该规范。

国家中心站点 443端口(https)
国家中心对接省分中心接口，详细接口列表见本文档中的“接口列表”章节。

省分中心对接地级市接口，详细接口列表见《省分中心对接地级市接口规范》文档中的“接口列表”章节。

当市县站点存在现有异构系统时遵循该规范。

省分中心对接公共电子阅览室接口，详细接口列表见《省分中心对接公共电子阅览室接口规范》文档中的“接口列表”章节。

当阅览室存在现有异构系统时遵循该规范。

地级市对接公共电子阅览室
接口，详细接口列表见《地级
市对接公共电子阅览室接口规范》文档中的“接口列表”章节。

当阅览室存在现有异构
系统时遵循该规范。

省分中心站点
443端口(https)
市级站点
443端口(https) 公共电子阅览室 443端口(https)
公共电子阅览室 443端口(https)
县级站点
443端口(https) 公共电子阅览室
443端口(https) 县分中心对接公共电子阅览室接口，详细接口列表见《县级对接公共电子阅览室接口规范》文档中的“接口列表”章节。

当阅览室存在现有异构系统时遵循该规范。

省分中心对接县分中心接口，详细接口列表见《省分中心对接县分中心接口规范》文档中的“接口列表”章节。

当阅览室存在现有异构系统时遵循该规范。

图中“443端口HTTPS”表示开发的服务端口，双向箭头线表示接口连接。

国家中心站点需开放基于HTTPS WebService的接口服务给省分中心站点连接，省分中心站点也需开放基于HTTPS WebService的接口服务给国家中心站点连接，详细接口列表请参见下一章“接口列表”，接口列表分两部分：国家中心提供的接口列表和省分中心提供的接口列表。

“接口详细描述”章节分两部分：1.接口使用的数据结构，说明了接口用到的字段、数据类型、字段说明等。

2.接口的调用原型，说明了调用接口时传入的参数和返回的数据结构。

三．适用范围
本规范适用于中国文化共享工程国家中心跟省分中心系统间的数据交换。

四. 规范性引用文件
下列规范所包含的条文，通过在本规范中引用而构成为本规范的条文。

使用本规范时应考虑使用其最新版本的可能性。

GB/T2260-2007中华人民共和国行政区划代码
GB/11643-1999公民身份证号码
GB/T2659-2000世界各国和地区名称代码
GB/T 4658-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 文档对象模型Document Object Model
DOM，W3C制定的XML应用程序接口中。

它将XML文档表示成一个树形的结构。

DOM规定了一系列编程指令，允许应用程序多次访问并操作文档树的组件。

5.4 TCP/IP
TCP/IP是用于互连各种网络的一组通信协议的总称，是一个开放式的协议集，遍布世界范围的Internet 网络主要采用的就是该协议，它主要包括TCP、IP、ARP、RARP、UDP 和SMTP 等协议。

5.5 公共电子阅览室
为了满足人民群众基本的网络文化需求，各级文化部门以公益性、基本性、均等性、便利性为原则，依托文化共享工程各级服务点、图书馆、文化馆，以及具备条件的工人文化宫、少年宫、妇女儿童活动中心、乡镇（街道）文化站、社区文化中心（村文化室）、学校、工业（产业）园区等，提供集互联网信息查询、文化共享工程信息资源服务、数字图书馆服务、培训、网络通讯、休闲娱乐等功能为一体的公共数字文化服务场所。

5.6 公共电子阅览室管理信息系统
为了规范公共电子阅览室用户上机行为、管理和监控公共电子阅览室网络信息、掌握公共电子阅览室运行服务状况，采用信息技术手段实现各级业务需求的信息化管理系统。

5.7 国家中心
是全国公共电子阅览室资源建设、技术支持、管理服务的中心，其职责由文化部全国文化信息资源建设。

5.8 省级分中心
是本省公共电子阅览室技术支持、资源建设及调度、管理服务、人员培训的中心，其职责由文化共享工程省级分中心承担。

5.9 地市级支中心
是本市公共电子阅览室技术支持、资源建设及调度、管理服务、人员培训的中心，其职责由文化共享工程地市级支中心承担。

5.10 WebService
Web Services是由企业发布的完成其特定商务需求的在线应用服务,其他公司或应用软件能够通过Internet来访问并使用这项在线服务。

5.11 WSDL
Web Services Description Language的缩写，是一个用来描述Web服务和说明如何与Web 服务通信的XML语言。

为用户提供详细的接口说明书。

5.12 SSL
安全套接层（Secure Sockets Layer，SSL）为Netscape所研发，采用公开密钥技术，保证两个应用间通信的保密性和可靠性，使客户与服务器应用之间的通信不被攻击者窃听。

可在服务器和客户机两端同时实现支持，目前已成为互联网上保密通讯的工业标准，现行Web 浏览器亦普遍将Http和SSL相结合，从而实现安全通信。

5.13 编码表
存储终端类型、电子阅览室类型等编码信息。

5.14 黑名单
指根据国家法律法规所禁止或不适宜在公共电子阅览室中访问的网站或应用列表。

5.15 推荐名单
指在公共电子阅览室中推荐用户访问的网站或应用列表。

5.16 白名单
指在公共电子阅览室中仅允许访问的网站或应用列表。

六．安全机制
IP访问限制安全机制：节点信息包含下级节点的IP地址，上级节点只接收指定IP地址的数据连接。

SSL 安全套接层：WebService接口服务部署在使用SSL安全机制的IIS服务器上，保证了数据的安全传输。

七．接口明细示意图
八．接口列表
根据所需要的功能和数据项，总体同步频率时间针对各个下级节点的数据传递要求做到可以自定义配置（可以设置同步时间[如每周、每日或每月的什么时间]或者同步周期[比如间隔5秒、1800秒等]），接口列表列出如下：
8.1国家中心提供的接口
国家中心需开放接口，被省分中心调用进行数据的传输。

10
11
12
13
14
8.2省分中心提供的接口
省分中心需开放接口，被国家中心调用进行数据的传输。

15
九．接口提供方式
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.1 STALOGINREQ 下级节点登录上级节点请求包
10.1.2 STALOGINRES下级节点登录上级节点返回包
10.1.3 UPSTATION各级节点信息结构
10.1.4 UPDEVICECONFIG节点服务器、存储、网络、软件配置表
10.1.5 UPEROOM各级电子阅览室信息结构
10.1.6 DOWNLOADREQ下载上级节点的各种信息参数
10.1.7 DOWNLOADINFO下载上级节点的各种信息
10.1.8 BWURL网址黑白名单
10.1.9 BWPROGRAM应用黑白名单
10.1.10 CODINGTABLE类型编码信息表
编码方案
10.1.11 UPCOMMENT意见信息
10.1.12 RCNA VICLASS资源导航栏目
10.1.13 RCNA VIINFO资源信息
10.1.14 UPW ARNINGREC报警信息
10.1.15 UPSTAFF工作管理人员信息
10.1.16 UPUSERULE电子阅览室上机规则
10.1.17 REMOTECTRLREQ截屏或控制命令请求包结构
10.1.18 REMOTECTRLRES截屏或控制命令应答包结构
10.1.19 UPRCNA VIREC网址访问记录
10.1.20 UPIMREC即时通讯
10.1.21 UPUSESTAT 使用统计记录
10.1.22 UPUSERECORD 使用记录结构
10.1.23 UPOPENRECORD 开关机记录
10.1.24 UPOPENSTAT 开关机统计
10.1.25 UPRCNA VISTAT 推荐网站访问统计记录
10.1.26 UPW ARNSTA T 报警信息统计记录
10.1.27 DEVLOADINFO终端设备信息结构
10.1.28 DEVSTARTINFO 开机记录结构
10.1.29 DEVENDINFO关机记录结构
10.1.30 DEVLOGININFO上机记录结构
10.1.31 DEVLOGOUTINFO下机记录结构
10.1.32 SPOTCHECKINFO 抽查表
10.1.33 SPOTCHECKRES 报告抽查结果
10.1.34 SRVINFO上级服务器表，数据包含直系上级节点，用于跨级连接。