校和家平台第三方接口规范

1 概述

本文档规定了校和家管理系统的第三方接口规范，第三方应用可以根据此文档进行接口对接。

2. 接口定义

2.1 协议

采用标准的restful API接口

采用HTTP1.1

POST方法采用Content-Type: application/json

数据格式为utf-8

2.2 签名方法

参与签名的参数: "random", "timestamp", "pid", "key"。"pid" 和 "key" 需校和家平台分配。"key" 不可作为参数传入接口。

参数名 ascii 码从小到大排序(字典序), 将参数名与参数值拼接成键值对的格式(即: key1=value1&key2=value2...), 得到 stringA

将 key 拼接到字符串的最后: stringB = string + '&key=value'

对 stringB 进行 MD5 运算, 将得到的字符串转换为大写

2.3 数据格式

正确返回数据格式

  {
    "code": 0,
    "message": "ok"
    "data":
  }

错误返回数据格式

  {
    "code": 10001
    "message": "数据不完整"
  }

3.1 接口列表

3.1.1 学生实时考勤打卡接口

请求地址

/otherapi/school/student/check

请求数据 POST

{
  "studentNo": String, // 必填，学生省学籍学号
  "studentName": String, // 学生姓名
  "className": String // 班级名称
  "checkState": String, // 考勤状态 ZD:正常到校 CD:迟到 KK:旷课 YD:异常到校 YL:异常离校 Zl:正常离校
  "checkDate": String, // 考勤时间，时间格式 yyyy-MM-dd HH:mm:ss
  "checkPhoto": String, // 考勤照片(不要超过1M)  照片读取出来的二进制格式转换成 base64 编码
  "note":String, //备注信息
}

说明

1、ZD 正常到校：在规定时间内入校打卡；
2、CD 迟到
3、KK 旷课
4、YD 异常到校：在规定时间外入校打卡；（可选）
5、YL 异常离校：在规定时间外离校打卡；（可选）
6、Zl 正常离校：在规定时间内离校打卡；（可选）

3.1.2 学生离校验证请假信息接口

请求地址

/otherapi/school/student/leave

请求数据 POST

{
  "studentNo": String, // 必填，学生省学籍学号
  "checkDate": String, // 离校时间，时间格式 yyyy-MM-dd HH:mm:ss
  "teacherNames": String[], // 非必填，教师名称列表 ["张三", "李四"]
}

说明

无

接口规范文档

校和家平台第三方接口规范#

1 概述#

2. 接口定义#

2.1 协议#

2.2 签名方法#

2.3 数据格式#

正确返回数据格式#

错误返回数据格式#

3.1 接口列表#

3.1.1 学生实时考勤打卡接口#

请求地址#

请求数据 POST#

说明#

3.1.2 学生离校验证请假信息接口#

请求地址#

请求数据 POST#

说明#

校和家平台第三方接口规范

1 概述

2. 接口定义

2.1 协议

2.2 签名方法

2.3 数据格式

正确返回数据格式

错误返回数据格式

3.1 接口列表

3.1.1 学生实时考勤打卡接口

请求地址

请求数据 POST

说明

3.1.2 学生离校验证请假信息接口

请求地址

请求数据 POST

说明