家长端-REST-API-概述.md 1.68 KB

家长端 REST API 概述

REST API 基本约束

  • API 被设计为符合 HTTP, REST 规范。例如:查询请求使用 Get 方法,提交请求使用 Post 方法。如果一个请求不是相应的 HTTP 方法,将返回错误。
  • 如无特殊说明,调用参数值应转码为:UTF-8, URL编码。

鉴权方式

oauth2.0 accesstoken方式

请求约束

请求头head 必须包含

(安卓)x-be-product  cn.boxfish.android.parent:{{版本号}}.{{打包方式}}

(ios)x-be-product   com.boxfishedu.parent:{{版本号}}.{{打包方式}}

流程逻辑

家长登录app,首先进行自动注册&登录;

之后输入学生绑定的手机号,会向学生手机发送验证码; 输入验证码后.完成家长和学生的绑定.

学生在提交学习时长是,会被计入今日学习时长的统计; 学生提交课程成绩时,会计入课程学习和今日学习时长的统计.

部署环境

测试服务器:https://api-online.test.boxfish.cn

生产服务器:https://api.boxfish.cn

测试环境帐号 密码为qqqqqq

学生id 学生帐号 家长token
100000000712 parenttteststu9@boxfish.cn parent9
100000000713 parenttteststu8@boxfish.cn parent8
100000000714 parenttteststu7@boxfish.cn
100000000715 parenttteststu6@boxfish.cn
100000000716 parenttteststu5@boxfish.cn
100000000717 parenttteststu4@boxfish.cn
100000000718 parenttteststu3@boxfish.cn
100000000719 parenttteststu2@boxfish.cn
100000000720 parenttteststu1@boxfish.cn
100000000721 parenttteststu0@boxfish.cn parent0