乐学喵接口文档
api 接口
一.乐学喵接口管理地址
1.接口文档的相关 api 地址
1.1 接口 api 说明
相关说明后期添加…
1.2 状态码说明
- 成功状态码:200
- 课程不存在:201
- 404 not found
2.选课页面
2.1 选课考试分类
请求路径:home/getFirstClassify
请求方式:GET
相应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42{
"code": 200,
"msg": "成功",
"data": [
{
"id": 1,
"title": "管理类联考",
"brief": "(会计/审计/图情/物流/工业工程/MBA/MPA/MEM)",
"is_show": 1
},
{
"id": 3,
"title": "考研公共课",
"brief": "(英语/政治)",
"is_show": 1
},
{
"id": 2,
"title": "经济类联考",
"brief": "(金融/应用统计/税务/国际商务/保险/资产评估)",
"is_show": 1
},
{
"id": 54,
"title": "四六级",
"brief": null,
"is_show": 0
},
{
"id": 57,
"title": "翻译硕士",
"brief": null,
"is_show": 0
},
{
"id": 87,
"title": "教育综合",
"brief": null,
"is_show": 0
}
]
}
2.2 选择考试分类详情
请求路径:home/getMajor/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 父级分类 id 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42{
"code": 200,
"msg": "成功",
"data": [
{
"major_id": 12,
"major_name": "会计硕士(MPAcc)"
},
{
"major_id": 13,
"major_name": "工商管理硕士(MBA)"
},
{
"major_id": 14,
"major_name": "审计硕士(MAud)"
},
{
"major_id": 16,
"major_name": "图书情报硕士(MLIS)"
},
{
"major_id": 18,
"major_name": "物流工程与管理(125604)"
},
{
"major_id": 20,
"major_name": "工业工程与管理(125603)"
},
{
"major_id": 15,
"major_name": "公共管理硕士(MPA)"
},
{
"major_id": 17,
"major_name": "工程管理与硕士(MEM)"
},
{
"major_id": 19,
"major_name": "旅游管理硕士(MTA)"
}
]
}
2.3 顶部导航左边标题
请求路径:home/exam/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 需要渲染的 id 可以为空 响应数据
1
2
3
4
5
6
7
8
9{
"code": 200,
"msg": "成功",
"data": {
"id": 3,
"title": "考研公共课",
"is_show": 1
}
}
2.4 今日直播
请求路径:home/liveToday/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 需要渲染的 id 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24{
"code": 200,
"msg": "成功",
"data": [
{
"id": 13028,
"title": "5月时政热点解读",
"course_chapter_id": 16367,
"room_video_id": "22060646895771",
"start_play": 1654599600,
"end_play": 1654605000,
"course_basis_id": 1303,
"basis_title": "23考研丨2022全年度艺姐时政热点解读",
"chapter_title": "艺姐2022全年时政解读",
"is_playback": 1,
"parent_course_chapter_id": 13027,
"course_type": 9,
"is_public": 1,
"play_type": 4,
"is_buy": 0,
"sys_course_id": 1302
}
]
}
2.5tab 内容
请求路径:home/getSecondClassify/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 需要渲染的 id 可以为空 响应数据
1
2
3
4
5{
"code": 200,
"msg": "成功",
"data": []
}
2.6 近期公开课
请求路径:home/marketingCourse/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 需要渲染的 id 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13{
"code": 200,
"msg": "成功",
"data": {
"id": 14,
"model_name": "近期公开课",
"classify_id": 3,
"created_at": 1618581932,
"created_id": 100,
"updated_at": 1648467735,
"course_list": []
}
}
2.7 推荐好课
请求路径:home/recommendCourse/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 classify_id 需要渲染的 id 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13{
"code": 200,
"msg": "成功",
"data": {
"id": 10,
"model_name": "推荐好课",
"classify_id": 3,
"created_at": 1618582938,
"created_id": 100,
"updated_at": 1648467741,
"course_list": []
}
}
2.8banner 列表
请求路径:home/banner/当前点击的 tab 的 id/4
请求方式:GET
响应参数
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36{
"code": 200,
"msg": "成功",
"data": [
{
"id": 252,
"title": "23康哥英语二VIP弟子班",
"classify_id": 12,
"banner_img": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/2021hpli7wd91638415730.jpg",
"banner_type_id": 4,
"link_local": 1,
"jump_type": 1,
"link_style": 2,
"link": "900",
"status": 0,
"sort": 6,
"created_at": 1638415737,
"updated_at": 1639970592
},
{
"id": 284,
"title": "23康哥英语一VIP弟子班",
"classify_id": 12,
"banner_img": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/2021x7wzo5fw1639970654.png",
"banner_type_id": 4,
"link_local": 1,
"jump_type": 1,
"link_style": 2,
"link": "899",
"status": 0,
"sort": 5,
"created_at": 1639970657,
"updated_at": 1639970657
}
]
}
2.9 点击 tabs 切换数据和搜索
请求路径:home/classifyCourse/:classify_id 【url 的动态路径,不能为空】
请求方式:GET
请求参数
参数 参数说明 备注 page 页码 可以为空 limit 条数 可以为空 classify_id 当前点击的 tabs 的 id 可以为空 title 搜索字段 可以为空 响应参数
1
2
3
4
5
6
7
8{
"code": 200,
"msg": "成功",
"limit": 15,
"total_count": 8,
"page": 1,
"data": []
}
3.详情
3.1 详情 info 数据
请求路径:courseInfo/basis_id=:basis_id/st=0 【url 路径动态】
请求方式:GET
请求参数
参数 参数说明 备注 basis_id 讲师 id 可以为空 st 0 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17{
"code": 200,
"msg": "成功",
"data": {
//基本信息
"info": {},
//banner列表
"banner": [],
"recommend": [],
"label_list": [],
//课程安排中的章节分类
"course_periods": [],
"datum": [],
//资料下载
"course_datum": []
}
}
3.2 详情课程评价
请求路径:getAllCommentByType
请求方式:POST
请求参数:
参数 参数说明 备注 course_id 详情 id 不能为空 type 1 不能为空 响应数据:
1
2
3
4
5
6
7
8
9{
"code": 200,
"msg": "成功",
"data": {
"total": 9,
"current_page": 1,
"list": []
}
}
3.3 详情的时间排序
请求路径:courseInfo/orderByChapterList/:course_id [url 动态路由传参]
请求方式:GET
请求参数
参数 参数说明 备注 course_id 1302 可以为空 响应数据
1
2
3
4
5{
code:200,
msg:"成功",
data:[...数据]
}
3.4 课前准备
请求路径:getWechatInfo/:id[url 动态路由传参]
请求方式:GET
请求参数
参数 参数说明 备注 **id** 1442 可以为空 响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24{
"code": 200,
"msg": "成功",
"data": {
//公众号
"wechat_info": null,
//添加助教
"teacher_wechat_info": {
"id": 37,
"name": "23管综学习包",
"guided_words": "添加助教,进学习群领高分资料",
"sign_guided_words": "进入学习交流群,找志同道合研友",
"explain1": "微信扫码添加助教",
"explain2": "",
"explain3": "",
"code_url": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/202170je2tk81640860570.png",
"created_at": 1623918381,
"updated_at": 1640860687,
"deleted_at": null,
"media_id": "B0PUinFPcRgd_RFw7Gqo2zTqv30G171ngtLPLSOfOyq8kY518ffg_YiyMRWk5PO7",
"media_at": 1654665931
}
}
}
4.我的登录注册
4.1 图形验证码
请求路径:getImgCode
请求方式:GET
响应数据
1
2
3
4
5
6
7
8
9
10
11
12{
"code": 200,
"msg": "成功",
"data": {
"url": {
"sensitive": false,
"key": "$2y$10$9540caGULpc8mraun0Gyl.2h2B4J/o8k8SUOYX3fC0ZSRmJmNLuqS",
//验证码图片
"img": ""
}
}
}
4.2appLogo
请求路径:webConfig
请求方式:GET
响应数据
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16{
"code": 200,
"msg": "成功",
"data": {
"site_name": "乐学喵",
"site_logo": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/2022tb70dk1a1645166432.png",
"site_description": "乐学喵",
"site_keywords": "乐学喵",
"site_copyright": "Copyright © 2018 京ICP备19028088号-1 京公网安备 11010802032607号 | 京网文 [2020] 0019-010号 | 北京乐学喵教育科技有限公司 版权所有 Powered by 乐学喵",
"site_webUrl": "",
"site_wapUrl": "",
"site_phone": "18888888888",
"IosCode": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/20196wxfe4911561965703.png",
"AndCode": "https://lexuemiao.oss-cn-beijing.aliyuncs.com/uploads/image/2019uloiocp61561809014.png"
}
}
4.3 获取手机验证码
请求路径:getsmscode
请求方式:POST
请求参数:
参数 参数说明 备注 mobile 手机号 不能为空 sms_type “login”,“editmobile” 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: 2597630
msg: "成功"
}
4.4 登录注册页登录
请求路径:login
请求方式:POST
请求参数:
参数 参数说明 备注 captcha 图片验证码 不能为空 device_id “1” 不能为空 device_type “2” 不能为空 key 图形验证码饭返回的 key 值 不能为空 mobile 手机号 不能为空 sms_code 手机验证码 不能为空 user_pass 手机密码 默认“000000” 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: {...返回基本信息}
msg: "成功"
}
4.5 设置密码
请求路径:getpassword
请求方式:POST
请求参数:
参数 参数说明 备注 mobile 手机号 不能为空 sms_code 手机验证码 不能为空 user_pass 手机密码 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: "修改成功"
msg: "成功"
}
4.6 用户基本信息
请求路径:showone/id=:id
请求方式:GET
响应数据
1
2
3
4
5{
code: 200
data: {user_id: 433775, user_name: "ZYWX_UZcYkD", user_nickname: "177****9202", sex: 3, birthday: "0",…}
msg: "成功"
}
4.7 关于我们
请求路径:about/type=1
请求方式:GET
响应数据
1
2
3
4
5{
code: 200
data: {about_info: {about_id: 1, type: 1,…}}
msg: "成功"
}
4.8 更新用户信息
请求路径 updateInfo
请求方式 PUT
请求参数
参数 参数说明 备注 birthday 出生日期 id 用户 id province_id 省份 city_id 市 area_id 区 grade_id 年级 id major 报考专业 响应数据
1
2
3
4
5{
code: 200
data: {info: "成功", avatar: ""}
msg: "成功"
}
4.9 省市区接口
请求路径:area/city
请求方式:POST
请求参数
参数 参数说明 备注 parent_id 省市区的 id 响应数据
1
2
3
4
5{
code: 200
data: {city_list: [{id: 110101, area_name: "东城区", area_code: "Dongcheng"},…]}
msg: "成功"
}
5.收藏
5.1 收藏的添加和删除
请求路径:collect
请求方式:POST
请求参数:
参数 参数说明 备注 basis_id 详情 id 不能为空 type 1 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: {is_collect: 1}
msg: "收藏成功"
}
5.2 收藏的列表
请求路径:collect
请求方式:GET
响应数据:
1
2
3
4
5{
code: 200
data: {total: 1, current_page: 1,…}
msg: "成功"
}
5.3 我的优惠券
请求路径:getUserCouponList
请求方式:GET
请求参数
参数 参数说明 备注 states 状态 不能为空 0:未使用
1:已使用
2 已过期
3 全部
响应数据:
1
2
3
4
5{
code: 200
data: {total: 0, current_page: 1, list: []}
msg: "成功"
}
5.4 问题反馈
请求路径:feedbackadd
请求方式:POST
请求参数
参数 参数说明 备注 feedback_info 内容 不能为空 user_id 用户 id 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: {id: 2370}
msg: "成功"
}
5.5 我的消息
请求路径:message/getMessage/message_classify=:id
请求方式:POST
请求参数
参数 参数说明 备注 message_classify 内容 不能为空 响应数据:
1
2
3
4
5{
code: 200
data: {total: 0, current_page: 1, list: []}
msg: "成功"
}
5.5 我的订单
请求方式:POST
请求参数
参数 参数说明 备注 page pay_states user_id 用户 id 1
2
3
4
5
6
7
8
9
10
11
12[
{
page: "first",
title: "全部",
id: 0,
pay_states: "",
},
{ page: "second", title: "待支付", id: 1, pay_states: 1 },
{ page: "third", title: "代收讲义", id: 2, pay_states: 8 },
{ page: "fourth", title: "已完成", id: 3, pay_states: 7 },
{ page: "fifth", title: "已取消", id: 4, pay_states: 3 },
];响应数据
1
2
3
4
5{
code: 200
data: {current_page: 1, data: [], first_page_url: "http://www.lexuemiao.com/api/order?page=1", from: null,…}
msg: "成功"
}
5.6 订单详情
请求方式 POST
请求参数
参数 参数说明 备注 order_id 订单 id 响应数据
1
2
3
4
5{
code: 200
data: {,…}
msg: "成功"
}
6.学习课程
6.1 我的课
请求路径:myCourse/studyCourseList
请求方式:GET
响应数据
1
2
3
4
5{
code: 200
data: [,…]
msg: "成功"
}
6.2 全部课程判断
请求路径:myCourse
请求方式:GET
请求参数
参数 参数说明 备注 type 0 is_free ‘’全部,2 付费,1 免费 study_status ‘’全部状态 1 学习中 2 已完成 3 已过期 4 已隐藏 响应数据
1
2
3
4
5{
code: 200
data: [,…]
msg: "成功"
}
6.3 学习记录
请求路径 myCourse/studyList
请求方式 GET
请求参数
参数 参数说明 备注 page 页数 limit 条数 响应数据
1
2
3
4
5
6
7
8{
code: 200
data: [{course_id: 1051, course_title: "23《老吕数学要点精编》逐题精讲", course_type: 5, course_periods_id: 10639,…},…]
limit: 15
msg: "成功"
page: 1
total_count: 2
}