扫码支付10元,阅读完整文章!
网校小程序服务端接口文档
登录注册类接口
-
解析微信code
API地址 |
/api/plugins/we_chat_app/sessions/{code} |
|||
Header |
Accept: "application/vnd.edusoho.v2+json" |
|||
请求类型 |
GET |
|||
入参 |
||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
无入参 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
出参 |
||||
参数名 |
类型 |
含义 |
备注 |
|
openid |
String |
Openid |
后面很多接口要用到这个openid |
|
session_key |
String |
Session_key |
|
|
|
|
|
|
|
|
|
|
|
-
登录已存在的网校用户
API地址 |
/api/plugins/we_chat_app/login |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
dataType |
txt |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
appId |
String |
微信小程序appId |
是 |
|
|
type |
String |
终端类型 |
是 |
wechat_app |
|
password |
String |
网校账号密码 |
是 |
|
|
openId |
String |
openid |
是 |
|
|
identify |
String |
网校账号ID |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
token |
String |
登录token |
|
|
|
user |
object |
网校账号信息 |
|
|
|
|
|
|
|
|
|
错误码(不是全部错误码,只提供了重要错误) |
|
||||
错误码 |
信息 |
备注 |
|
||
12 |
已存在绑定关系 |
说明用户已完成微信与网校账号的绑定操作,可调用token接口做登录操作,获取登录token |
|
-
Token接口(获取登录信息)
API地址 |
/api/plugins/we_chat_app/token |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
appId |
String |
微信小程序appId |
是 |
|
|
type |
String |
终端类型 |
是 |
Type = wechat_app |
|
openId |
String |
openId |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
token |
String |
登录token |
|
|
|
user |
object |
网校账号信息 |
|
|
|
|
|
|
|
|
|
错误码(不是全部错误码,只提供了重要错误) |
|
||||
错误码 |
信息 |
备注 |
|
||
11 |
用户未绑定 |
遇到此错误,应引导用户去做账号绑定操作 |
|
-
发送注册短信验证码
API地址 |
/api/plugins/we_chat_app/smscenter |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
dataType |
txt |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
type |
String |
验证码类型 |
是 |
Type = register |
|
mobile |
String |
手机号码 |
是 |
|
|
|
|
|
|
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
smsToken |
String |
短信验证码token |
调用注册接口时需要使用 |
|
|
|
|
|
|
|
-
注册网校账号(手机号)
API地址 |
/api/plugins/we_chat_app/smscenter |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
dataType |
txt |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
appId |
String |
微信小程序appId |
是 |
|
|
type |
String |
终端类型 |
是 |
Type = wechat_app |
|
password |
String |
网校账号密码 |
是 |
|
|
openId |
String |
openId |
是 |
|
|
mobile |
String |
手机号 |
是 |
|
|
smsCode |
String |
注册验证码 |
是 |
|
|
nickname |
String |
网校昵称 |
是 |
|
|
token |
String |
登录token |
是 |
|
|
avatar |
String |
头像URL |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
token |
String |
登录token |
|
|
|
user |
object |
网校账号信息 |
|
|
课程类接口
-
首页展示数据
API地址 |
/api/pages/miniprogram/discoveries |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
Json列表 |
Json |
课程列表,VIP信息列表 |
每个列表项对应一个首页的展示模块 |
|
-
所有课程界面-课程菜单
API地址 |
/mapi_v2/Category/getCategorieTree |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
无 |
|
|
|
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
课程列表 |
|
|
-
所有课程列表(“更多”按钮)
API地址 |
/api/plugins/we_chat_app/course?sort=recommendedSeq&offset=0&limit=10 |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
limit |
int |
显示几条数据 |
否 |
|
|
categoryId |
Int |
课程分类ID |
否 |
筛选对应分类的课程列表时使用 |
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
课程列表 |
|
|
-
获得课程信息(课程页面)
API地址 |
/api/pages/miniprogram/courses/{课程ID} |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
courseItems |
Json |
课程目录列表 |
|
|
|
courseSet |
Json |
课程标题、课程介绍、课程价格 |
|
|
|
learningExpiryDate |
Json |
学习有效期 |
|
|
|
learnMode |
String |
学习方式 |
freeMode = 免费 |
|
|
reviews |
Json |
学员评价列表 |
|
|
|
teachers |
Json |
教师列表 |
|
|
-
加入学习
API地址 |
/api/courses/{课程ID}/members |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
返回值 |
包含课程到期时间等信息 |
|
-
打开课时(获得课时信息)
API地址 |
/api/plugins/we_chat_app/lesson/{课时ID} |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
课时信息 |
包含课时类型,视频URL等 |
|
我的学习接口
-
我的课程列表接口
API地址 |
/api/me/courses?sort=created_time&offset=0&limit=10 |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
limit |
String |
获取多少条数据 |
否 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
我的课程列表 |
|
|
-
我的班级列表接口
API地址 |
/api/me/classrooms?sort=created_time&offset=0&limit=10&format=pagelist |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
limit |
String |
获取多少条数据 |
否 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
我的班级列表 |
|
|
“我的”栏目接口
-
我的信息接口
API地址 |
/api/me |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
Json |
Json |
用户信息 |
包含头像、昵称等 |
|
-
我的订单接口
API地址 |
/api/me/orders?offset=0&sort=-created_time |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
我的订单列表 |
|
|
开通会员接口
-
会员等级列表接口
API地址 |
/api/plugins/vip/vip_levels |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
Json |
Json |
会员等级列表 |
|
|
-
会员等级对应的课程列表、班级列表接口
API地址 |
/api/plugins/vip/pages/h5/vips/{会员等级ID} |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
POST |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
token |
String |
登录token |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
Json |
Json |
会员等级对应的课程列表、班级列表 |
|
|
-
“更多”课程列表
API地址 |
/api/plugins/vip/vip_courses?sort=-price&levelId=5&offset=0 |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
levelId |
int |
等级ID |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
课程列表 |
|
|
-
“更多”班级列表
API地址 |
/api/plugins/vip/vip_classrooms?sort=-price&levelId=5&offset=0 |
||||
Header |
Accept: "application/vnd.edusoho.v2+json" |
||||
请求类型 |
Get |
||||
入参 |
|||||
参数名 |
类型 |
含义 |
是否必传 |
备注 |
|
sort |
String |
排序方式 |
否 |
|
|
offset |
int |
从第几条数据开始获取 |
否 |
|
|
levelId |
int |
等级ID |
是 |
|
|
出参 |
|||||
参数名 |
类型 |
含义 |
备注 |
|
|
JSON |
Json |
班级列表 |
|
|
- 还没有人评论,欢迎说说您的想法!