智慧校园综合管理平台数据接口规范.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数据请求命令command11

3.3响应结果result和description11

3.4数据内容data11

3.4.1获取统计信息12

3.4.2获取/推送内容信息15

3.4.3获取使用信息17

应用，均需要按照本规范进行开发。

1・3定义和说明

1.3.1网址设定

为简化接口描述中的网址，首先在此处定义好各相关系统的网址。

①市级管理系统，智慧校园综合管理平台：简写为SERVER」Pc

②学校各应用系统：简写为ITAPP」P。

132数据交换

指的是数据提供方通过各种方式将数据传送到的需求方的过程，根据需要，可以单向和双向交换。

第二章接口总体设计

2.1接口管理流程

（接申请）

接审批

接口配置

接

口

管接口使用

理

（接口关闭）

①所有外部应用系统（现有运行系统及未来开发系统）接均需要具体业务部门在线提出申请；

②申请经有关部门审批通过后才会被接；

③双方配合对接口进行配置并调试通过；

④按照大平台要求规范使用接口，并定期更新加密key；

⑤接II过期后会自动关闭，管理员也可以随时主动关闭接口，关闭后的接口也可被管理员再次打开。

2・2接申请和配置流程

①所有接大平台的外部应用系统均需在大平台上走申请流程，申请内容包括审核需要的必备信息、

需要哪些类型数据（数据表和字段）、以及数据范围等；

②大平台数据审核人评估风险后，拒绝则退回申请，同意后，进配置接口；

③大平台系统管理员根据申请内容，配置接口数据，包括：外部应用在大平台的口，外部应用系

统网址和端口号，接口方式，大平台对应接口网址和端口号，加密方式，接口有效期等；

④外部应用申请人根据大平台接口配置.，在外部应用系统做匹配性开发和配置.，启用接口。

2.3接口访问流程

客户端

服务端

A1-请求