智慧校园综合管理平台-接口规范.pdfVIP

智慧校园综合管理平台 智慧校园综合管理平台 数据接口规范 数据接口规范 目录 第一章 引言 4 1.1 编写目的4 1.2 文档范围4 1.3 定义和说明5 1.3.1 网址设定5 1.3.2 数据交换5 第二章 接口总体设计 6 2.1 接口管理流程6 2.2 接入申请和配置流程6 2.3 接口访问流程7 2.4 接口协议7 2.5 请求体标准格式8 2.5.1 请求报文8 2.5.2 应答报文8 2.5.3 接口示例9 2.6 数据采用增量式同步方法9 2.7 传输安全10 2.7.1 加密传输10 2.7.2 明文传输10 第三章 接口规范 11 3.1 服务器uuid11 3.2 数据请求命令command 11 3.3 result description11 响应结果 和 3.4 数据内容data 11 3.4.1 获取统计信息12 3.4.2 获取 推送内容信息/ 15 3.4.3 获取使用信息17 第一章 引言 第一章 引言 1.1编写目的 1.1编写目的 本文档主要用于 “智慧校园综合管理平台” （下文简称 “大平台”）信息系统规划与建设，将各学校 分散、异构的智慧校园应用系统、设备和信息资源进行整合，通过数据接口的方式，实现各种应用系统、 设备和教学资源的数据汇集，用于教育局对全市/区的智慧校园发展状况分析。本接口规范用于指导各软件 开发商、设备供应商与 “智慧校园综合管理平台”的数据互联互通。 1.2文档范围 1.2文档范围 接口关系图 根据上图所示， “智慧校园综合管理平台”与学校系统的连接关系，如果学校有智慧校园大平台，则 学校大平台收集内部系统数据，然后统一与 “智慧校园综合管理平台”进行数据交换；如果学校没有智慧 校园大平台，则学校内每个应用系统或设备都需要开发与 “智慧校园综合管理平台”的数据交换接口。 本规范适用于所有连接到 “智慧校园综合管理平台”的信息化应用系统的数据交换，凡在此范围内的 应用，均需要按照本规范进行开发。 1.3定义和说明 1.3定义和说明 1.3.1网址设定 为简化接口描述中的网址，首先在此处定义好各相关系统的网址。 1 市级管理系统，智慧校园综合管理平台：简写为SERVER_IP。 2 学校各应用系统：简写为ITAPP_IP。 1.3.2数据交换 指的是数据提供方通过各种方式将数据传送到的需求方的过程，根据需要，可以单向和双向交换。 第二章接 口总体设计 第二章接 口总体设计 2.1接口管理流程 2.1接口管理流程 1 所有外部应用系统 （现有运行系统及未来开发系统）接入均需要具体业务部门在线提出申请； 2 申请经有关部门审批通过后才会被接入； 3 双方配合对接口进行配置并调试通过； 4 按照大平台要求规范使用接口，并定期更新加密key； 5 接口过期后会自动关闭，管理员也可以随时主动关闭接口，关闭后的接口也可被管理员再次打开。 2.2接入申请和配置流程 2.2接入申请和配置流程 1 所有接入大平台的外部应用系统均需在大平台上走申请流程，申请内容包括审核需要的必备信息、 需要哪些类型数据 （数据表和字段）、以及数据范围等； 2 大平台数据审核人评估风险后，拒绝则退回申请，同意后，进入配置接口； 3 大平台系统管理员根据申请内容，配置接口数据，包括：外部应用在大平台的入口，外部应用系 统网址和端口号，接口方式，大平台对应接口网址和端口号，加密方式，接口有效期等； 4 外部