API使用说明
API Endpoint
测试环境:
http://classbrand.staging.adachina.net
生产环境：
TBD
演示环境:
TBD
请求格式
传递表单时, Header需要声明使用JSON格式传递：
Content-Type: application/json
非GET类请求，请求参数需要提供带上authenticity_token:
{
"authenticity_token": "1HxW...sa234="
}
分页信息
分页字段
列表类接口，会带上分页信息。
| 字段名 | 描述 |
|---|---|
| pages | 列表总页数 |
| page | 当前显示页 |
| total | 列表资源总数 |
| items | 当前显示资源数量 |
| items_per_page | 默认每页资源数量 |
分页参数
列表类接口可通过以下分页参数，控制返回信息。
| 参数名 | 参数类型 | 必填 | 描述 | 示例 |
|---|---|---|---|---|
| page | integer | 否 | 返回页 | 2 |
示例:
GET /system_management/schools?page=2
身份验证
除登陆接口外，所有API接口都会验证用户身份。如身份验证失败，接口会返回以下错误的一种。
未登陆
Status: 401 Unauthorized
{
"error_code": 1007,
"message": "用户未登陆"
}
权限不足
Status: 401 Unauthorized
{
"error_code": 1008,
"message": "当前接口仅允许系统管理员使用"
}
搜索参数
除非特别标明其他搜索方式。列表类资源请求参数如带有搜索参数，使用以下方式对资源进行搜索。
示例:
如在教师列表接口按教师姓名搜索
GET https://api.endpoint/teachers?search=王易