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

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": 1,  1为正常返回
    "message": "ok"
    "data":
  }

错误返回数据格式

    {
        "code": -1,
        "message": "签名验证失败"
    }

3.1 接口列表

3.1.1 学校学生总数

请求地址

http://otherapi.xiaohejia.com/otherapi/school/student/getSchoolStudentCount

请求数据 POST

{
    无
}

说明

{
"code": 1,
"StudentCount": 106,
"message": "ok"
}
StudentCount 返回学校学生数

3.1.2 请假学生总数

请求地址

http://otherapi.xiaohejia.com/otherapi/school/student/getVacationStudentCount

请求数据 POST


  "startDate": String, // 查询请假的开始时间，时间格式 yyyy-MM-dd HH:mm:ss 非必填 默认请求当天0时0分0秒
  "endDate": String, // 查询请假的结束时间，时间格式 yyyy-MM-dd HH:mm:ss 非必填 默认请求当前时间

说明

{
"awaitCount": 2,
"accomplishCount": 0,
"code": 1,
"sum": 2,
"unratifiedCount": 0,
"message": "ok"
}
awaitCount 待批准请假学生数量
accomplishCount 请假完成学生数量
unratifiedCount 未批准请假数量
sum 请假学生总数

学生数

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

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

说明