meedu v2

基础路径

API BASE URL

Auth-V3

社交账号登录

v4.8新增

GET/api/v3/auth/login/socialite/{app}

请求 Request

QUERY

s_urlstring必填
登录成功跳转地址
f_urlstring必填
登录失败跳转地址
actionstring必填
可选值：login , bind
行为[login:登录,bind:绑定]

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/auth/login/socialite/{app}?s_url=string&f_url=string&action=login

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

微信公众号授权登录

v4.8新增

GET/api/v3/auth/login/wechat/oauth

请求 Request

QUERY

s_urlstring必填
登录成功跳转地址
f_urlstring必填
登录失败跳转地址
actionstring必填
可选值：login , bind
行为[login:登录,bind:绑定]

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/auth/login/wechat/oauth?s_url=string&f_url=string&action=login

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

微信公众号扫码登录

v4.8新增

GET/api/v3/auth/login/wechat/scan

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.codestring必填
  code
- data.imagestring必填
  二维码

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code": "string",
5    "image": "string"
6  }
7}

微信公众号扫码登录结果查询

v4.8新增

GET/api/v3/auth/login/wechat/scan/query

请求 Request

QUERY

codestring必填
code

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.successstring必填
  状态[-1:不做任何操作,1:登录成功,0:登录失败]
- data.tokenstring必填
  token
- data.codestring必填
  code(失败返回)
- data.actionstring必填
  actionbind_mobile:绑定手机号

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/auth/login/wechat/scan/query?code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "success": "string",
5    "token": "string",
6    "code": "string",
7    "action": "string"
8  }
9}

三方账号登录

v4.8新增

POST/api/v3/auth/login/code

请求 Request

QUERY

codestring必填
社交的登录返回的code

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.successnumber必填
  是否成功[1:是,0:否]
- data.tokenstring必填
  登录成功后的用户token[success=1时返回]
- data.actionstring必填
  可选值：bind_mobile
  登录失败后需要进一步操作[bind_mobile:需要现绑定手机号]

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v3/auth/login/code?code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "success": "fake_simple_value",
5    "token": "string",
6    "action": "bind_mobile"
7  }
8}

社交账号注册[绑定手机号]

v4.8新增

POST/api/v3/auth/register/withSocialite

请求 Request

QUERY

codestring必填
社交的登录返回的code
mobilestring必填
手机号
mobile_codestring必填
短信验证码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.tokenstring必填
  用户token

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v3/auth/register/withSocialite?code=string&mobile=string&mobile_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "token": "string"
5  }
6}

微信扫码注册[绑定手机号]

v4.8新增

POST/api/v3/auth/register/withWechatScan

请求 Request

QUERY

codestring必填
微信扫码的code
mobilestring必填
手机号
mobile_codestring必填
短信验证码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.tokenstring必填
  用户token

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v3/auth/register/withWechatScan?code=string&mobile=string&mobile_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "token": "string"
5  }
6}

Auth

安全退出

POST/api/v2/logout

响应 Response

状态码 200

参数

codenumber
0成功,非0失败

Example 1

成功示例

1{
2  "code": "fake_simple_value"
3}

短信登录

POST/api/v2/login/mobile

请求 Request

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.tokenstring必填
  token

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/login/mobile?mobile=string&mobile_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "token": "string"
5  }
6}

密码登录

POST/api/v2/login/password

请求 Request

QUERY

mobilestring必填
手机号
passwordstring必填
密码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.tokenstring必填
  token

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/login/password?mobile=string&password=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "token": "string"
5  }
6}

社交APP登录[重定向]

app可选值:[qq]. 登录成功之后会在success_redirect中携带token返回

GET/api/v2/login/socialite/{app}

请求 Request

QUERY

success_redirectstring必填
成功之后的跳转URL(需要urlEncode)
failed_redirectstring必填
失败之后跳转的URL(需要urlEncode)

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/login/socialite/{app}?success_redirect=string&failed_redirect=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

微信扫码登录[二维码]

GET/api/v2/login/wechatScan

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.codestring必填
  随机值
- data.imagestring必填
  图片内容

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code": "string",
5    "image": "string"
6  }
7}

微信扫码登录[结果查询]

GET/api/v2/login/wechatScan/query

请求 Request

QUERY

codestring必填
随机值

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.statusnumber必填
  结果[1:登录成功,0:失败]
- data.tokenstring必填
  token[登录成功返回]

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/login/wechatScan/query?code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "status": "fake_simple_value",
5    "token": "string"
6  }
7}

重置密码

POST/api/v2/password/reset

请求 Request

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码
passwordstring必填
密码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/password/reset?mobile=string&mobile_code=string&password=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

短信注册

POST/api/v2/register/sms

请求 Request

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码
passwordstring必填
密码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/register/sms?mobile=string&mobile_code=string&password=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

微信公众号授权登录[重定向]

登录成功之后会在success_redirect中携带token返回

GET/api/v2/login/wechat/oauth

请求 Request

QUERY

success_redirectstring必填
成功之后的跳转URL(需要urlencode)
failed_redirectstring必填
失败之后跳转的URL(需要urlencode)

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/login/wechat/oauth?success_redirect=string&failed_redirect=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

VIP

VIP会员详情

GET/api/v2/role/{id}

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.idnumber必填
  VIPid
- data.namestring必填
  VIP名
- data.chargenumber必填
  价格
- data.expire_daysnumber必填
  有效天数
- data.desc_rowsarray必填
  描述

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "name": "string",
6    "charge": "fake_simple_value",
7    "expire_days": "fake_simple_value",
8    "desc_rows": []
9  }
10}

VIP会员列表

GET/api/v2/roles

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.idnumber必填
  VIPid
- data.namestring必填
  VIP名
- data.chargenumber必填
  价格
- data.expire_daysnumber必填
  有效天数
- data.desc_rowsarray必填
  描述

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "name": "string",
7      "charge": "fake_simple_value",
8      "expire_days": "fake_simple_value",
9      "desc_rows": []
10    }
11  ]
12}

其它

公告详情

GET/api/v2/announcement/{id}

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.announcementstring必填
  公告内容
- data.titlestring必填
  标题
- data.view_timesnumber必填
  浏览次数
- data.created_atstring必填
  时间

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "announcement": "string",
5    "title": "string",
6    "view_times": "fake_simple_value",
7    "created_at": "string"
8  }
9}

公告列表

GET/api/v2/announcements

请求 Request

QUERY

pagenumber
可选值：1
page
sizenumber
可选值：10
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.announcementstring必填
  公告内容
- data.titlestring必填
  标题
- data.view_timesnumber必填
  浏览次数
- data.created_atstring必填
  创建时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/announcements?page=1&size=10

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "announcement": "string",
6      "title": "string",
7      "view_times": "fake_simple_value",
8      "created_at": "string"
9    }
10  ]
11}

图形验证码

GET/api/v2/captcha/image

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.keystring必填
  随机键值
- data.imgstring必填
  图片base64码

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "key": "string",
5    "img": "string"
6  }
7}

发送短信

POST/api/v2/captcha/sms

请求 Request

QUERY

mobilestring必填
手机号
image_captchastring必填
图形验证码
image_keystring必填
图形验证码随机值
scenestring必填
可选值：login , register , password_reset , mobile_bind
scene

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/captcha/sms?mobile=string&image_captcha=string&image_key=string&scene=login

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

友情链接

GET/api/v2/links

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.namestring必填
  链接名
- data.urlstring必填
  链接

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "name": "string",
6      "url": "string"
7    }
8  ]
9}

首页导航

GET/api/v2/navs

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.namestring必填
  导航名
- data.urlstring必填
  链接
- data.active_routesstring必填
  子导航active[英文逗号连接]
- data.blanknumber必填
  新窗口打开[1:是,0否]
- data.childrenarray必填
  子导航
  - 数组成员object
  - children.namestring必填
    子导航名
  - children.urlstring必填
    子导航链接
  - children.blanknumber必填
    新窗口打开[1:是,0否]

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "name": "string",
6      "url": "string",
7      "active_routes": "string",
8      "blank": "fake_simple_value",
9      "children": [
10        {
11          "name": "string",
12          "url": "string",
13          "blank": "fake_simple_value"
14        }
15      ]
16    }
17  ]
18}

幻灯片

GET/api/v2/sliders

请求 Request

QUERY

platformstring
可选值："PC"
平台

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.thumbstring必填
  图片URL
- data.urlstring必填
  链接
- data.platformstring必填
  平台
- data.sortnumber必填
  升序

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/sliders?platform=%22PC%22

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "thumb": "string",
5    "url": "string",
6    "platform": "string",
7    "sort": "fake_simple_value"
8  }
9}

系统配置

GET/api/v2/other/config

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.webnamestring必填
  网站名
- data.urlstring必填
  网站地址
- data.pc_urlstring必填
  PC网站地址
- data.h5_urlstring必填
  H5网站地址
- data.icpstring必填
  ICP备案号
- data.user_protocolstring必填
  用户协议URL
- data.user_private_protocolstring必填
  用户隐私协议URL
- data.aboutusstring必填
  关于我们
- data.logostring必填
  LOGO的URL
- data.playerobject必填
  播放器
  - 子属性
  - player.coverstring必填
    播放器封面
  - player.enabled_bullet_secretnumber必填
    开启跑马灯[1:是,0否]
  - player.bullet_secretobject必填
    跑马灯配置
    子属性
    bullet_secret.textstring必填
    跑马灯-内容
    bullet_secret.colorstring必填
    跑马灯-颜色
    bullet_secret.opacitystring必填
    跑马灯-透明度
    bullet_secret.sizenumber必填
    跑马灯—文字大小
  - player.textstring必填
    跑马灯-内容
  - player.colorstring必填
    跑马灯-颜色
  - player.opacitystring必填
    跑马灯-透明度
  - player.sizenumber必填
    跑马灯—文字大小
- data.memberobject必填
  - 子属性
  - member.enabled_mobile_bind_alertnumber必填
    强制绑定手机号[1:是,0否]
- data.socialites.qqnumber必填
  QQ登录[1:是,0否]
- data.socialites.wechat_scannumber必填
  微信扫码登录[1:是,0否]
- data.socialites.wechat_oauthnumber必填
  微信授权登录[1:是,0否]
- data.credit1_reward.registernumber必填
  注册送积分
- data.credit1_reward.watched_vod_coursenumber必填
  看完录播课送积分
- data.credit1_reward.watched_videonumber必填
  看完视频
- data.credit1_reward.paid_ordernumber必填
  支付订单[按订单金额比率奖励积分]
- data.credit1_reward.invitenumber必填
  邀请用户注册
- data.enabled_addonsarray必填
  已启用插件

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "webname": "string",
5    "url": "string",
6    "pc_url": "string",
7    "h5_url": "string",
8    "icp": "string",
9    "user_protocol": "string",
10    "user_private_protocol": "string",
11    "aboutus": "string",
12    "logo": "string",
13    "player": {
14      "cover": "string",
15      "enabled_bullet_secret": "fake_simple_value",
16      "bullet_secret": {
17        "text": "string",
18        "color": "string",
19        "opacity": "string",
20        "size": "fake_simple_value"
21      },
22      "text": "string",
23      "color": "string",
24      "opacity": "string",
25      "size": "fake_simple_value"
26    },
27    "member": {
28      "enabled_mobile_bind_alert": "fake_simple_value"
29    },
30    "socialites.qq": "fake_simple_value",
31    "socialites.wechat_scan": "fake_simple_value",
32    "socialites.wechat_oauth": "fake_simple_value",
33    "credit1_reward.register": "fake_simple_value",
34    "credit1_reward.watched_vod_course": "fake_simple_value",
35    "credit1_reward.watched_video": "fake_simple_value",
36    "credit1_reward.paid_order": "fake_simple_value",
37    "credit1_reward.invite": "fake_simple_value",
38    "enabled_addons": []
39  }
40}

上传图片

POST/api/v2/upload/image

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

filestring必填
图片文件

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.pathstring必填
  本地路径
- data.urlstring必填
  URL
- data.diskstring必填
  存储磁盘
- data.namestring必填
  文件名

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/upload/image?file=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "path": "string",
5    "url": "string",
6    "disk": "string",
7    "name": "string"
8  }
9}

录播课

附件下载

GET/api/v2/course/attach/{attach_id}/download

请求 Request

QUERY

tokenstring必填
登录token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/course/attach/{attach_id}/download?token=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

录播课程分类

GET/api/v2/course_categories

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.idnumber必填
  分类ID
- data.namestring必填
  分类名
- data.parent_idnumber必填
  分类父ID
- data.childrenarray必填
  子类
  - 数组成员object
  - children.idnumber必填
    子分类ID
  - children.namestring必填
    子分类名

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "name": "string",
7      "parent_id": "fake_simple_value",
8      "children": [
9        {
10          "id": "fake_simple_value",
11          "name": "string"
12        }
13      ]
14    }
15  ]
16}

录播课程评论[提交]

POST/api/v2/course/{course_id}/comment

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

contentstring必填
评论内容

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/course/{course_id}/comment?content=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

录播课程评论列表

GET/api/v2/course/{course_id}/comments

请求 Request

QUERY

pagenumber
页码
page_sizenumber
每页条数

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.commentsarray必填
  评论
  - 数组成员object
  - comments.idnumber必填
    评论ID
  - comments.user_idnumber必填
    用户ID
  - comments.render_contentstring必填
    评论内容
  - comments.created_atstring必填
    时间
- data.usersarray必填
  用户
  - 数组成员object
  - users.idnumber必填
    用户ID
  - users.nick_namestring必填
    用户昵称
  - users.avatarstring必填
    用户头像
  - users.mobilestring必填
    用户手机号

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/course/{course_id}/comments?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "comments": [
5      {
6        "id": "fake_simple_value",
7        "user_id": "fake_simple_value",
8        "render_content": "string",
9        "created_at": "string"
10      }
11    ],
12    "users": [
13      {
14        "id": "fake_simple_value",
15        "nick_name": "string",
16        "avatar": "string",
17        "mobile": "string"
18      }
19    ]
20  }
21}

录播课程详情

GET/api/v2/course/{id}

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.courseobject必填
  课程
  - 子属性
  - course.idnumber必填
    课程ID
  - course.titlestring必填
    课程名
  - course.thumbstring必填
    封面
  - course.chargenumber必填
    价格
  - course.short_descriptionstring必填
    简短介绍
  - course.render_descstring必填
    详细介绍
  - course.seo_keywordsstring必填
    SEO关键字
  - course.seo_descriptionstring必填
    SEO描述
  - course.published_atstring必填
    上架时间
  - course.is_recnumber必填
    推荐[1:是,0否][已弃用]
  - course.user_countnumber必填
    订阅人数
  - course.videos_countnumber必填
    视频数
  - course.categoryobject必填
    分类
    子属性
    category.idnumber必填
    分类ID
    category.namestring必填
    分类名
  - course.idnumber必填
    分类ID
  - course.namestring必填
    分类名
- data.chaptersarray必填
  章节
  - 数组成员object
  - chapters.idnumber必填
    章节ID
  - chapters.titlestring必填
    章节名
- data.videosarray必填
  视频
  - 数组成员object
  - videos.idnumber必填
    视频ID
  - videos.titlestring必填
    视频名
  - videos.chargenumber必填
    视频价格
  - videos.view_numnumber必填
    观看数[已废弃]
  - videos.short_descriptionstring必填
    简短介绍
  - videos.render_descstring必填
    详细介绍[已废弃]
  - videos.published_atstring必填
    上架时间
  - videos.durationnumber必填
    时长[单位：秒]
  - videos.seo_keywordsstring必填
    SEO关键字
  - videos.seo_descriptionstring必填
    SEO描述
  - videos.is_ban_sellnumber必填
    禁止出售[1:是,0否]
  - videos.chapter_idnumber必填
    章节ID
- data.isBuynumber必填
  购买[1:是,0否]
- data.isCollectnumber必填
  收藏[1:是,0否]
- data.videoWatchedProgressobject必填
  视频进度
  - 子属性
  - videoWatchedProgress.idnumber必填
    记录ID
  - videoWatchedProgress.user_idnumber必填
    用户ID
  - videoWatchedProgress.course_idnumber必填
    课程ID
  - videoWatchedProgress.video_idnumber必填
    视频ID
  - videoWatchedProgress.watch_secondsnumber必填
    已观看秒数
  - videoWatchedProgress.watched_atstring必填
    看完时间
- data.attacharray必填
  附件
  - 数组成员object
  - attach.idnumber必填
    附件ID
  - attach.sizenumber必填
    附件大小[单位：字节]
  - attach.namestring必填
    附件名
  - attach.extensionstring必填
    附件扩展名
- data.buyVideosarray必填
  已购视频ID

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "course": {
6        "id": "fake_simple_value",
7        "title": "string",
8        "thumb": "string",
9        "charge": "fake_simple_value",
10        "short_description": "string",
11        "render_desc": "string",
12        "seo_keywords": "string",
13        "seo_description": "string",
14        "published_at": "string",
15        "is_rec": "fake_simple_value",
16        "user_count": "fake_simple_value",
17        "videos_count": "fake_simple_value",
18        "category": {
19          "id": "fake_simple_value",
20          "name": "string"
21        },
22        "name": "string"
23      },
24      "chapters": [
25        {
26          "id": "fake_simple_value",
27          "title": "string"
28        }
29      ],
30      "videos": [
31        {
32          "id": "fake_simple_value",
33          "title": "string",
34          "charge": "fake_simple_value",
35          "view_num": "fake_simple_value",
36          "short_description": "string",
37          "render_desc": "string",
38          "published_at": "string",
39          "duration": "fake_simple_value",
40          "seo_keywords": "string",
41          "seo_description": "string",
42          "is_ban_sell": "fake_simple_value",
43          "chapter_id": "fake_simple_value"
44        }
45      ],
46      "isBuy": "fake_simple_value",
47      "isCollect": "fake_simple_value",
48      "videoWatchedProgress": {
49        "id": "fake_simple_value",
50        "user_id": "fake_simple_value",
51        "course_id": "fake_simple_value",
52        "video_id": "fake_simple_value",
53        "watch_seconds": "fake_simple_value",
54        "watched_at": "string"
55      },
56      "attach": [
57        {
58          "id": "fake_simple_value",
59          "size": "fake_simple_value",
60          "name": "string",
61          "extension": "string"
62        }
63      ],
64      "buyVideos": []
65    }
66  ]
67}

收藏课程

GET/api/v2/course/{course_id}/like

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

contentstring必填
评论内容

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/course/{course_id}/like?content=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

录播课程列表

GET/api/v2/courses

请求 Request

QUERY

pagenumber
page
page_sizenumber
page_size
category_idnumber
分类ID
scenestring
可选值：sub , free
场景[sub:订阅最多,free:免费课程]

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.idnumber必填
  课程ID
- data.titlestring必填
  课程名
- data.thumbstring必填
  封面
- data.chargenumber必填
  价格
- data.short_descriptionstring必填
  简短介绍
- data.render_descstring必填
  详细介绍
- data.seo_keywordsstring必填
  SEO关键字
- data.seo_descriptionstring必填
  SEO描述
- data.published_atstring必填
  上架时间
- data.is_recnumber必填
  推荐[1:是,0否][已弃用]
- data.is_freenumber必填
  免费课程[1:是,0否]
- data.user_countnumber必填
  订阅人数
- data.videos_countnumber必填
  视频数
- data.categoryobject必填
  分类
  - 子属性
  - category.idnumber必填
    分类ID
  - category.namestring必填
    分类名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/courses?page=fake_simple_value&page_size=fake_simple_value&category_id=fake_simple_value&scene=sub

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "title": "string",
7      "thumb": "string",
8      "charge": "fake_simple_value",
9      "short_description": "string",
10      "render_desc": "string",
11      "seo_keywords": "string",
12      "seo_description": "string",
13      "published_at": "string",
14      "is_rec": "fake_simple_value",
15      "is_free": "fake_simple_value",
16      "user_count": "fake_simple_value",
17      "videos_count": "fake_simple_value",
18      "category": {
19        "id": "fake_simple_value",
20        "name": "string"
21      }
22    }
23  ]
24}

录播视频评论

POST/api/v2/video/{id}/comment

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

contentstring必填
评论内容

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/video/{id}/comment?content=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

录播视频评论列表

GET/api/v2/video/{video_id}/comments

请求 Request

QUERY

pagenumber
页码
page_sizenumber
每页条数

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.commentsarray必填
  评论
  - 数组成员object
  - comments.idnumber必填
    评论ID
  - comments.user_idnumber必填
    用户ID
  - comments.render_contentstring必填
    评论内容
  - comments.created_atstring必填
    时间
- data.usersarray必填
  用户
  - 数组成员object
  - users.idnumber必填
    用户ID
  - users.nick_namestring必填
    用户昵称
  - users.avatarstring必填
    用户头像
  - users.mobilestring必填
    用户手机号

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/video/{video_id}/comments?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "comments": [
5      {
6        "id": "fake_simple_value",
7        "user_id": "fake_simple_value",
8        "render_content": "string",
9        "created_at": "string"
10      }
11    ],
12    "users": [
13      {
14        "id": "fake_simple_value",
15        "nick_name": "string",
16        "avatar": "string",
17        "mobile": "string"
18      }
19    ]
20  }
21}

录播视频详情

GET/api/v2//video/{id}

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.videoobject必填
  - 子属性
  - video.idnumber必填
    视频ID
  - video.titlestring必填
    视频名
  - video.chargenumber必填
    视频价格
  - video.view_numnumber必填
    观看次数
  - video.short_descriptionstring必填
    简短介绍
  - video.published_atstring必填
    上架时间
  - video.durationnumber必填
    时长[单位：秒]
  - video.seo_keywordsstring必填
    SEO关键字
  - video.seo_descriptionstring必填
    SEO描述
  - video.is_ban_sellnumber必填
    禁止出售[1:是,0否]
  - video.ban_dragnumber必填
    禁止拖拽播放[1:是,0否]
  - video.chapter_idnumber必填
    章节ID
- data.videosarray必填
  - 数组成员object
  - videos.idnumber必填
    视频ID
  - videos.titlestring必填
    视频名
  - videos.chargenumber必填
    视频价格
  - videos.view_numnumber必填
    观看数[已废弃]
  - videos.short_descriptionstring必填
    简短介绍
  - videos.render_descstring必填
    详细介绍[已废弃]
  - videos.published_atstring必填
    上架时间
  - videos.durationnumber必填
    时长[单位：秒]
  - videos.seo_keywordsstring必填
    SEO关键字
  - videos.seo_descriptionstring必填
    SEO描述
  - videos.is_ban_sellnumber必填
    禁止出售[1:是,0否]
  - videos.ban_dragnumber必填
    禁止拖拽播放[1:是,0否]
  - videos.chapter_idnumber必填
    章节ID
- data.courseobject必填
  课程
  - 子属性
  - course.idnumber必填
    课程ID
  - course.titlestring必填
    课程名
  - course.thumbstring必填
    封面
  - course.chargenumber必填
    价格
  - course.short_descriptionstring必填
    简短介绍
  - course.render_descstring必填
    详细介绍
  - course.seo_keywordsstring必填
    SEO关键字
  - course.seo_descriptionstring必填
    SEO描述
  - course.published_atstring必填
    上架时间
  - course.is_recnumber必填
    推荐[1:是,0否][已弃用]
  - course.user_countnumber必填
    订阅人数
  - course.videos_countnumber必填
    视频数
  - course.categoryobject必填
    分类
    子属性
    category.idnumber必填
    分类ID
    category.namestring必填
    分类名
  - course.idnumber必填
    分类ID
  - course.namestring必填
    分类名
- data.chaptersarray必填
  章节
  - 数组成员object
  - chapters.idnumber必填
    章节ID
  - chapters.namestring必填
    章节名
- data.is_watchnumber必填
  是否可以观看[1:是,0否]
- data.videoWatchedProgressobject必填
  视频进度
  - 子属性
  - videoWatchedProgress.idnumber必填
    记录ID
  - videoWatchedProgress.user_idnumber必填
    用户ID
  - videoWatchedProgress.course_idnumber必填
    课程ID
  - videoWatchedProgress.video_idnumber必填
    视频ID
  - videoWatchedProgress.watch_secondsnumber必填
    已观看秒数
  - videoWatchedProgress.watched_atstring必填
    看完时间
- data.buy_videosarray必填
  已购视频ID

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "video": {
5      "id": "fake_simple_value",
6      "title": "string",
7      "charge": "fake_simple_value",
8      "view_num": "fake_simple_value",
9      "short_description": "string",
10      "published_at": "string",
11      "duration": "fake_simple_value",
12      "seo_keywords": "string",
13      "seo_description": "string",
14      "is_ban_sell": "fake_simple_value",
15      "ban_drag": "fake_simple_value",
16      "chapter_id": "fake_simple_value"
17    },
18    "videos": [
19      {
20        "id": "fake_simple_value",
21        "title": "string",
22        "charge": "fake_simple_value",
23        "view_num": "fake_simple_value",
24        "short_description": "string",
25        "render_desc": "string",
26        "published_at": "string",
27        "duration": "fake_simple_value",
28        "seo_keywords": "string",
29        "seo_description": "string",
30        "is_ban_sell": "fake_simple_value",
31        "ban_drag": "fake_simple_value",
32        "chapter_id": "fake_simple_value"
33      }
34    ],
35    "course": {
36      "id": "fake_simple_value",
37      "title": "string",
38      "thumb": "string",
39      "charge": "fake_simple_value",
40      "short_description": "string",
41      "render_desc": "string",
42      "seo_keywords": "string",
43      "seo_description": "string",
44      "published_at": "string",
45      "is_rec": "fake_simple_value",
46      "user_count": "fake_simple_value",
47      "videos_count": "fake_simple_value",
48      "category": {
49        "id": "fake_simple_value",
50        "name": "string"
51      },
52      "name": "string"
53    },
54    "chapters": [
55      {
56        "id": "fake_simple_value",
57        "name": "string"
58      }
59    ],
60    "is_watch": "fake_simple_value",
61    "videoWatchedProgress": {
62      "id": "fake_simple_value",
63      "user_id": "fake_simple_value",
64      "course_id": "fake_simple_value",
65      "video_id": "fake_simple_value",
66      "watch_seconds": "fake_simple_value",
67      "watched_at": "string"
68    },
69    "buy_videos": []
70  }
71}

公共视频播放

GET/api/v2/video/open/play

请求 Request

QUERY

file_idstring必填
视频文件ID
servicestring必填
视频文件存储服务

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.urlstring必填
  播放URL
- data.formatstring必填
  视频格式
- data.durationnumber必填
  时长,单位:秒
- data.namestring必填
  清晰度

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/video/open/play?file_id=string&service=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "url": "string",
5    "format": "string",
6    "duration": "fake_simple_value",
7    "name": "string"
8  }
9}

录播视频播放地址

GET/api/v2/video/{id}/playinfo

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

is_trynumber必填
是否试看[1:是,0否]

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.urlstring必填
  播放URL
- data.formatstring必填
  视频格式
- data.durationnumber必填
  时长,单位:秒
- data.namestring必填
  清晰度

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/video/{id}/playinfo?is_try=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "url": "string",
5    "format": "string",
6    "duration": "fake_simple_value",
7    "name": "string"
8  }
9}

视频观看时长记录

POST/api/v2/video/{id}/record

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

durationnumber必填
已观看时长,单位：秒

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/video/{id}/record?duration=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

录播视频列表

GET/api/v2/videos

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    视频ID
  - data.titlestring必填
    视频名
  - data.chargenumber必填
    视频价格
  - data.view_numnumber必填
    观看数[已废弃]
  - data.short_descriptionstring必填
    简短介绍
  - data.render_descstring必填
    详细介绍[已废弃]
  - data.published_atstring必填
    上架时间
  - data.durationnumber必填
    时长[单位：秒]
  - data.seo_keywordsstring必填
    SEO关键字
  - data.seo_descriptionstring必填
    SEO描述
  - data.is_ban_sellnumber必填
    禁止出售[1:是,0否]
  - data.chapter_idnumber必填
    章节ID

Example 1

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "title": "string",
9        "charge": "fake_simple_value",
10        "view_num": "fake_simple_value",
11        "short_description": "string",
12        "render_desc": "string",
13        "published_at": "string",
14        "duration": "fake_simple_value",
15        "seo_keywords": "string",
16        "seo_description": "string",
17        "is_ban_sell": "fake_simple_value",
18        "chapter_id": "fake_simple_value"
19      }
20    ]
21  }
22}

搜索-V3

全站搜索

GET/api/v3/search

请求 Request

QUERY

keywordsstring必填
搜索关键字
typestring必填
可选值：vod:录播课 , video:录播视频 , live:直播课 , book:电子书 , topic:图文 , paper:试卷 , practice:练习 , mock_paper:模拟卷
课程类型
sizenumber必填
每页数量
pagenumber必填
页码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    资源ID
  - data.resource_idnumber必填
    资源ID
  - data.resource_typestring必填
    资源类型
  - data.titlestring必填
    标题
  - data.short_descstring必填
    简短介绍
  - data.descstring必填
    详细介绍
  - data.thumbstring必填
    封面
  - data.chargenumber必填
    价格

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/search?keywords=string&type=vod%3A%E5%BD%95%E6%92%AD%E8%AF%BE&size=fake_simple_value&page=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "data": [
5      {
6        "id": "fake_simple_value",
7        "resource_id": "fake_simple_value",
8        "resource_type": "string",
9        "title": "string",
10        "short_desc": "string",
11        "desc": "string",
12        "thumb": "string",
13        "charge": "fake_simple_value"
14      }
15    ]
16  }
17}

搜索

录播课程搜索

GET/api/v2/search

请求 Request

QUERY

keywordsstring必填
搜索关键字
sizenumber必填
每页数量
pagenumber必填
页码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.idnumber必填
  课程ID
- data.titlestring必填
  课程名
- data.thumbstring必填
  封面
- data.chargenumber必填
  价格
- data.short_descriptionstring必填
  简短介绍
- data.render_descstring必填
  详细介绍
- data.seo_keywordsstring必填
  SEO关键字
- data.seo_descriptionstring必填
  SEO描述
- data.published_atstring必填
  上架时间
- data.is_recnumber必填
  推荐[1:是,0否][已弃用]
- data.user_countnumber必填
  订阅人数
- data.videos_countnumber必填
  视频数
- data.categoryobject必填
  分类
  - 子属性
  - category.idnumber必填
    分类ID
  - category.namestring必填
    分类名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/search?keywords=string&size=fake_simple_value&page=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "title": "string",
6    "thumb": "string",
7    "charge": "fake_simple_value",
8    "short_description": "string",
9    "render_desc": "string",
10    "seo_keywords": "string",
11    "seo_description": "string",
12    "published_at": "string",
13    "is_rec": "fake_simple_value",
14    "user_count": "fake_simple_value",
15    "videos_count": "fake_simple_value",
16    "category": {
17      "id": "fake_simple_value",
18      "name": "string"
19    }
20  }
21}

用户-V3

已学习录播课

GET/api/v3/member/courses/learned

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber必填
page
sizenumber必填
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.learned_countnumber必填
    已学习课时
  - data.idnumber必填
    记录ID
  - data.is_watchednumber必填
    是否看完[1:是,0:否]
  - data.watched_atstring必填
    看完时间
  - data.progressnumber必填
    进度[0-100]
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近观看时间
  - data.is_subscribenumber必填
    是否订阅课程[1:是,0:否]
  - data.courseobject必填
    课程
    子属性
    course.titlestring必填
    课程名
    course.thumbstring必填
    课程封面
    course.videos_countnumber必填
    总课时
    course.chargenumber必填
    价格
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    课程封面
  - data.videos_countnumber必填
    总课时
  - data.chargenumber必填
    价格
  - data.last_view_videoobject必填
    最近观看的视频记录
    子属性
    last_view_video.idnumber必填
    记录id
    last_view_video.video_idnumber必填
    videoId
    last_view_video.watch_secondsnumber必填
    已观看秒数
    last_view_video.created_atstring必填
    观看开始时间
    last_view_video.updated_atstring必填
    最近一次观看时间
    last_view_video.watched_atstring必填
    看完时间
    last_view_video.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
    last_view_video.idnumber必填
    videoId
    last_view_video.titlestring必填
    视频名
    last_view_video.durationnumber必填
    视频时长[s]
    last_view_video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    记录id
  - data.video_idnumber必填
    videoId
  - data.watch_secondsnumber必填
    已观看秒数
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近一次观看时间
  - data.watched_atstring必填
    看完时间
  - data.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    videoId
  - data.titlestring必填
    视频名
  - data.durationnumber必填
    视频时长[s]
  - data.published_atstring必填
    视频上架时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/member/courses/learned?page=fake_simple_value&size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "learned_count": "fake_simple_value",
8        "id": "fake_simple_value",
9        "is_watched": "fake_simple_value",
10        "watched_at": "string",
11        "progress": "fake_simple_value",
12        "created_at": "string",
13        "updated_at": "string",
14        "is_subscribe": "fake_simple_value",
15        "course": {
16          "title": "string",
17          "thumb": "string",
18          "videos_count": "fake_simple_value",
19          "charge": "fake_simple_value"
20        },
21        "title": "string",
22        "thumb": "string",
23        "videos_count": "fake_simple_value",
24        "charge": "fake_simple_value",
25        "last_view_video": {
26          "id": "fake_simple_value",
27          "video_id": "fake_simple_value",
28          "watch_seconds": "fake_simple_value",
29          "created_at": "string",
30          "updated_at": "string",
31          "watched_at": "string",
32          "video": {
33            "id": "fake_simple_value",
34            "title": "string",
35            "duration": "fake_simple_value",
36            "published_at": "string"
37          },
38          "title": "string",
39          "duration": "fake_simple_value",
40          "published_at": "string"
41        },
42        "video_id": "fake_simple_value",
43        "watch_seconds": "fake_simple_value",
44        "video": {
45          "id": "fake_simple_value",
46          "title": "string",
47          "duration": "fake_simple_value",
48          "published_at": "string"
49        },
50        "duration": "fake_simple_value",
51        "published_at": "string"
52      }
53    ]
54  }
55}

收藏课程

GET/api/v3/member/courses/like

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber必填
page
sizenumber必填
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.course_idnumber必填
    课程ID
  - data.user_idnumber必填
    用户ID
  - data.created_atstring必填
    收藏时间
  - data.learned_countnumber必填
    已学习课时
  - data.watch_recordobject必填
    观看进度记录
    子属性
    watch_record.idnumber必填
    记录ID
    watch_record.is_watchednumber必填
    是否看完[1:是,0:否]
    watch_record.watched_atstring必填
    看完时间
    watch_record.progressnumber必填
    进度[0-100]
    watch_record.created_atstring必填
    观看开始时间
    watch_record.updated_atstring必填
    最近观看时间
  - data.idnumber必填
    记录ID
  - data.is_watchednumber必填
    是否看完[1:是,0:否]
  - data.watched_atstring必填
    看完时间
  - data.progressnumber必填
    进度[0-100]
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近观看时间
  - data.courseobject必填
    课程
    子属性
    course.titlestring必填
    课程名
    course.thumbstring必填
    课程封面
    course.videos_countnumber必填
    总课时
    course.chargenumber必填
    价格
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    课程封面
  - data.videos_countnumber必填
    总课时
  - data.chargenumber必填
    价格
  - data.last_view_videoobject必填
    最近观看的视频记录
    子属性
    last_view_video.idnumber必填
    记录id
    last_view_video.video_idnumber必填
    videoId
    last_view_video.watch_secondsnumber必填
    已观看秒数
    last_view_video.created_atstring必填
    观看开始时间
    last_view_video.updated_atstring必填
    最近一次观看时间
    last_view_video.watched_atstring必填
    看完时间
    last_view_video.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
    last_view_video.idnumber必填
    videoId
    last_view_video.titlestring必填
    视频名
    last_view_video.durationnumber必填
    视频时长[s]
    last_view_video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    记录id
  - data.video_idnumber必填
    videoId
  - data.watch_secondsnumber必填
    已观看秒数
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近一次观看时间
  - data.watched_atstring必填
    看完时间
  - data.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    videoId
  - data.titlestring必填
    视频名
  - data.durationnumber必填
    视频时长[s]
  - data.published_atstring必填
    视频上架时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/member/courses/like?page=fake_simple_value&size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "course_id": "fake_simple_value",
8        "user_id": "fake_simple_value",
9        "created_at": "string",
10        "learned_count": "fake_simple_value",
11        "watch_record": {
12          "id": "fake_simple_value",
13          "is_watched": "fake_simple_value",
14          "watched_at": "string",
15          "progress": "fake_simple_value",
16          "created_at": "string",
17          "updated_at": "string"
18        },
19        "id": "fake_simple_value",
20        "is_watched": "fake_simple_value",
21        "watched_at": "string",
22        "progress": "fake_simple_value",
23        "updated_at": "string",
24        "course": {
25          "title": "string",
26          "thumb": "string",
27          "videos_count": "fake_simple_value",
28          "charge": "fake_simple_value"
29        },
30        "title": "string",
31        "thumb": "string",
32        "videos_count": "fake_simple_value",
33        "charge": "fake_simple_value",
34        "last_view_video": {
35          "id": "fake_simple_value",
36          "video_id": "fake_simple_value",
37          "watch_seconds": "fake_simple_value",
38          "created_at": "string",
39          "updated_at": "string",
40          "watched_at": "string",
41          "video": {
42            "id": "fake_simple_value",
43            "title": "string",
44            "duration": "fake_simple_value",
45            "published_at": "string"
46          },
47          "title": "string",
48          "duration": "fake_simple_value",
49          "published_at": "string"
50        },
51        "video_id": "fake_simple_value",
52        "watch_seconds": "fake_simple_value",
53        "video": {
54          "id": "fake_simple_value",
55          "title": "string",
56          "duration": "fake_simple_value",
57          "published_at": "string"
58        },
59        "duration": "fake_simple_value",
60        "published_at": "string"
61      }
62    ]
63  }
64}

已购录播课

GET/api/v3/member/courses

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber必填
page
sizenumber必填
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.course_idnumber必填
    课程ID
  - data.user_idnumber必填
    用户ID
  - data.chargenumber必填
    购买价格
  - data.created_atstring必填
    购买时间
  - data.learned_countnumber必填
    已学习课时
  - data.watch_recordobject必填
    观看进度记录
    子属性
    watch_record.idnumber必填
    记录ID
    watch_record.is_watchednumber必填
    是否看完[1:是,0:否]
    watch_record.watched_atstring必填
    看完时间
    watch_record.progressnumber必填
    进度[0-100]
    watch_record.created_atstring必填
    观看开始时间
    watch_record.updated_atstring必填
    最近观看时间
  - data.idnumber必填
    记录ID
  - data.is_watchednumber必填
    是否看完[1:是,0:否]
  - data.watched_atstring必填
    看完时间
  - data.progressnumber必填
    进度[0-100]
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近观看时间
  - data.courseobject必填
    课程
    子属性
    course.titlestring必填
    课程名
    course.thumbstring必填
    课程封面
    course.videos_countnumber必填
    总课时
    course.chargenumber必填
    价格
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    课程封面
  - data.videos_countnumber必填
    总课时
  - data.chargenumber必填
    价格
  - data.last_view_videoobject必填
    最近观看的视频记录
    子属性
    last_view_video.idnumber必填
    记录id
    last_view_video.video_idnumber必填
    videoId
    last_view_video.watch_secondsnumber必填
    已观看秒数
    last_view_video.created_atstring必填
    观看开始时间
    last_view_video.updated_atstring必填
    最近一次观看时间
    last_view_video.watched_atstring必填
    看完时间
    last_view_video.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
    last_view_video.idnumber必填
    videoId
    last_view_video.titlestring必填
    视频名
    last_view_video.durationnumber必填
    视频时长[s]
    last_view_video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    记录id
  - data.video_idnumber必填
    videoId
  - data.watch_secondsnumber必填
    已观看秒数
  - data.created_atstring必填
    观看开始时间
  - data.updated_atstring必填
    最近一次观看时间
  - data.watched_atstring必填
    看完时间
  - data.videoobject必填
    子属性
    video.idnumber必填
    videoId
    video.titlestring必填
    视频名
    video.durationnumber必填
    视频时长[s]
    video.published_atstring必填
    视频上架时间
  - data.idnumber必填
    videoId
  - data.titlestring必填
    视频名
  - data.durationnumber必填
    视频时长[s]
  - data.published_atstring必填
    视频上架时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/member/courses?page=fake_simple_value&size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "course_id": "fake_simple_value",
8        "user_id": "fake_simple_value",
9        "charge": "fake_simple_value",
10        "created_at": "string",
11        "learned_count": "fake_simple_value",
12        "watch_record": {
13          "id": "fake_simple_value",
14          "is_watched": "fake_simple_value",
15          "watched_at": "string",
16          "progress": "fake_simple_value",
17          "created_at": "string",
18          "updated_at": "string"
19        },
20        "id": "fake_simple_value",
21        "is_watched": "fake_simple_value",
22        "watched_at": "string",
23        "progress": "fake_simple_value",
24        "updated_at": "string",
25        "course": {
26          "title": "string",
27          "thumb": "string",
28          "videos_count": "fake_simple_value",
29          "charge": "fake_simple_value"
30        },
31        "title": "string",
32        "thumb": "string",
33        "videos_count": "fake_simple_value",
34        "last_view_video": {
35          "id": "fake_simple_value",
36          "video_id": "fake_simple_value",
37          "watch_seconds": "fake_simple_value",
38          "created_at": "string",
39          "updated_at": "string",
40          "watched_at": "string",
41          "video": {
42            "id": "fake_simple_value",
43            "title": "string",
44            "duration": "fake_simple_value",
45            "published_at": "string"
46          },
47          "title": "string",
48          "duration": "fake_simple_value",
49          "published_at": "string"
50        },
51        "video_id": "fake_simple_value",
52        "watch_seconds": "fake_simple_value",
53        "video": {
54          "id": "fake_simple_value",
55          "title": "string",
56          "duration": "fake_simple_value",
57          "published_at": "string"
58        },
59        "duration": "fake_simple_value",
60        "published_at": "string"
61      }
62    ]
63  }
64}

注销账户

v4.8新增

POST/api/v3/member/destroy

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v3/member/destroy

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

社交账号绑定

v4.8新增

POST/api/v3/member/socialite/bindWithCode

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

stringstring必填
code

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v3/member/socialite/bindWithCode?string=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

微信账号扫码绑定

v4.8新增*

GET/api/v3/member/wechatScanBind

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.codestring必填
  code
- data.imagestring必填
  二维码

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/member/wechatScanBind

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code": "string",
5    "image": "string"
6  }
7}

用户

修改头像

POST/api/v2/member/detail/avatar

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

filestring必填
头像文件

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/detail/avatar?file=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

已学习录播课程

GET/api/v2/member/courses/history

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    课程ID
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    封面
  - data.chargenumber必填
    价格
  - data.short_descriptionstring必填
    简短介绍
  - data.render_descstring必填
    详细介绍
  - data.seo_keywordsstring必填
    SEO关键字
  - data.seo_descriptionstring必填
    SEO描述
  - data.published_atstring必填
    上架时间
  - data.is_recnumber必填
    推荐[1:是,0否][已弃用]
  - data.user_countnumber必填
    订阅人数
  - data.videos_countnumber必填
    视频数
  - data.categoryobject必填
    分类
    子属性
    category.idnumber必填
    分类ID
    category.namestring必填
    分类名
  - data.idnumber必填
    分类ID
  - data.namestring必填
    分类名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/courses/history?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "title": "string",
9        "thumb": "string",
10        "charge": "fake_simple_value",
11        "short_description": "string",
12        "render_desc": "string",
13        "seo_keywords": "string",
14        "seo_description": "string",
15        "published_at": "string",
16        "is_rec": "fake_simple_value",
17        "user_count": "fake_simple_value",
18        "videos_count": "fake_simple_value",
19        "category": {
20          "id": "fake_simple_value",
21          "name": "string"
22        },
23        "name": "string"
24      }
25    ]
26  }
27}

已收藏录播课程

GET/api/v2/member/courses/like

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    课程ID
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    封面
  - data.chargenumber必填
    价格
  - data.short_descriptionstring必填
    简短介绍
  - data.render_descstring必填
    详细介绍
  - data.seo_keywordsstring必填
    SEO关键字
  - data.seo_descriptionstring必填
    SEO描述
  - data.published_atstring必填
    上架时间
  - data.is_recnumber必填
    推荐[1:是,0否][已弃用]
  - data.user_countnumber必填
    订阅人数
  - data.videos_countnumber必填
    视频数
  - data.categoryobject必填
    分类
    子属性
    category.idnumber必填
    分类ID
    category.namestring必填
    分类名
  - data.idnumber必填
    分类ID
  - data.namestring必填
    分类名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/courses/like?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "title": "string",
9        "thumb": "string",
10        "charge": "fake_simple_value",
11        "short_description": "string",
12        "render_desc": "string",
13        "seo_keywords": "string",
14        "seo_description": "string",
15        "published_at": "string",
16        "is_rec": "fake_simple_value",
17        "user_count": "fake_simple_value",
18        "videos_count": "fake_simple_value",
19        "category": {
20          "id": "fake_simple_value",
21          "name": "string"
22        },
23        "name": "string"
24      }
25    ]
26  }
27}

已购录播课程

GET/api/v2/member/courses

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    课程ID
  - data.titlestring必填
    课程名
  - data.thumbstring必填
    封面
  - data.chargenumber必填
    价格
  - data.short_descriptionstring必填
    简短介绍
  - data.render_descstring必填
    详细介绍
  - data.seo_keywordsstring必填
    SEO关键字
  - data.seo_descriptionstring必填
    SEO描述
  - data.published_atstring必填
    上架时间
  - data.is_recnumber必填
    推荐[1:是,0否][已弃用]
  - data.user_countnumber必填
    订阅人数
  - data.videos_countnumber必填
    视频数
  - data.categoryobject必填
    分类
    子属性
    category.idnumber必填
    分类ID
    category.namestring必填
    分类名
  - data.idnumber必填
    分类ID
  - data.namestring必填
    分类名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/courses?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "title": "string",
9        "thumb": "string",
10        "charge": "fake_simple_value",
11        "short_description": "string",
12        "render_desc": "string",
13        "seo_keywords": "string",
14        "seo_description": "string",
15        "published_at": "string",
16        "is_rec": "fake_simple_value",
17        "user_count": "fake_simple_value",
18        "videos_count": "fake_simple_value",
19        "category": {
20          "id": "fake_simple_value",
21          "name": "string"
22        },
23        "name": "string"
24      }
25    ]
26  }
27}

积分明细

GET/api/v2/member/credit1Records

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    记录ID
  - data.sumnumber必填
    变动额度
  - data.remarkstring必填
    备注
  - data.created_atstring必填
    时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/credit1Records?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "sum": "fake_simple_value",
9        "remark": "string",
10        "created_at": "string"
11      }
12    ]
13  }
14}

用户详情

GET/api/v2/member/detail

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.idnumber必填
  用户ID
- data.avatarstring必填
  头像
- data.nick_namestring必填
  头像
- data.mobilestring必填
  手机号
- data.is_locknumber必填
  锁定[1:是,0否]
- data.is_activenumber必填
  激活[1:是,0否][暂无用]
- data.is_password_setnumber必填
  设置密码[1:是,0否]
- data.is_set_nicknamenumber必填
  设置昵称[1:是,0否]
- data.credit1number必填
  积分
- data.credit2number必填
  预留
- data.credit3number必填
  预留
- data.role_idnumber必填
  VIP会员ID
- data.role_expired_atstring必填
  VIP过期时间
- data.invite_balancenumber必填
  邀请余额
- data.roleobject必填
  VIP会员[可选]
  - 子属性
  - role.idnumber必填
    ID
  - role.namestring必填
    VIP名
- data.is_bind_qqnumber必填
  是否绑定QQ[1:是,0:否]
- data.is_bind_wechatnumber必填
  是否绑定微信[1:是,0:否]
- data.is_bind_mobilenumber必填
  是否绑定手机号[1:是,0:否]
- data.invite_people_countnumber必填
  邀请人数

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/detail

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "avatar": "string",
6    "nick_name": "string",
7    "mobile": "string",
8    "is_lock": "fake_simple_value",
9    "is_active": "fake_simple_value",
10    "is_password_set": "fake_simple_value",
11    "is_set_nickname": "fake_simple_value",
12    "credit1": "fake_simple_value",
13    "credit2": "fake_simple_value",
14    "credit3": "fake_simple_value",
15    "role_id": "fake_simple_value",
16    "role_expired_at": "string",
17    "invite_balance": "fake_simple_value",
18    "role": {
19      "id": "fake_simple_value",
20      "name": "string"
21    },
22    "is_bind_qq": "fake_simple_value",
23    "is_bind_wechat": "fake_simple_value",
24    "is_bind_mobile": "fake_simple_value",
25    "invite_people_count": "fake_simple_value"
26  }
27}

消息全部标记已读

GET/api/v2/member/notificationMarkAllAsRead

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/notificationMarkAllAsRead

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

消息标记已读

GET/api/v2/member/notificationMarkAsRead/{notificationId}

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/notificationMarkAsRead/{notificationId}

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

站内消息

GET/api/v2/member/messages

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
- 数组成员object
- data.idnumber必填
  记录ID
- data.notifiable_idstring必填
  特征值
- data.datastring必填
  消息内容
- data.read_atstring必填
  阅读时间
- data.created_atstring必填
  创建时间

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/messages?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "notifiable_id": "string",
7      "data": "string",
8      "read_at": "string",
9      "created_at": "string"
10    }
11  ]
12}

手机号绑定

POST/api/v2/member/detail/mobile

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/detail/mobile?mobile=string&mobile_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

手机号更换

PUT/api/v2/member/mobile

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码
signstring必填
校验字符串

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

PUT

{{BASE_URL}}/api/v2/member/mobile?mobile=string&mobile_code=string&sign=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

修改昵称

POST/api/v2/member/detail/nickname

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

nick_namestring必填
新昵称

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/detail/nickname?nick_name=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

订单列表

GET/api/v2/member/orders

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    订单ID
  - data.user_idnumber必填
    用户ID
  - data.chargenumber必填
    价格
  - data.order_idstring必填
    订单编号
  - data.payment_methodstring必填
    支付渠道
  - data.payment_textstring必填
    支付方法
  - data.status_textstring必填
    状态
  - data.created_atstring必填
    创建时间
  - data.continue_paynumber必填
    继续支付[1:是,0否][已废弃]
  - data.goodsarray必填
    商品
    数组成员object
    goods.idnumber必填
    商品ID
    goods.numnumber必填
    商品数量
    goods.goods_textstring必填
    商品类型名
    goods.goods_chargenumber必填
    商品价格
    goods.goods_typestring必填
    商品类型
    goods.goods_namestring必填
    商品名
    goods.goods_thumbstring必填
    商品封面
    goods.chargestring必填
    总价
    goods.goods_ori_chargestring必填
    商品原价
  - data.idnumber必填
    商品ID
  - data.numnumber必填
    商品数量
  - data.goods_textstring必填
    商品类型名
  - data.goods_chargenumber必填
    商品价格
  - data.goods_typestring必填
    商品类型
  - data.goods_namestring必填
    商品名
  - data.goods_thumbstring必填
    商品封面
  - data.chargestring必填
    总价
  - data.goods_ori_chargestring必填
    商品原价

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/orders?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "user_id": "fake_simple_value",
9        "charge": "string",
10        "order_id": "string",
11        "payment_method": "string",
12        "payment_text": "string",
13        "status_text": "string",
14        "created_at": "string",
15        "continue_pay": "fake_simple_value",
16        "goods": [
17          {
18            "id": "fake_simple_value",
19            "num": "fake_simple_value",
20            "goods_text": "string",
21            "goods_charge": "fake_simple_value",
22            "goods_type": "string",
23            "goods_name": "string",
24            "goods_thumb": "string",
25            "charge": "string",
26            "goods_ori_charge": "string"
27          }
28        ],
29        "num": "fake_simple_value",
30        "goods_text": "string",
31        "goods_charge": "fake_simple_value",
32        "goods_type": "string",
33        "goods_name": "string",
34        "goods_thumb": "string",
35        "goods_ori_charge": "string"
36      }
37    ]
38  }
39}

修改密码

POST/api/v2/member/detail/password

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码
passwordstring必填
新密码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/detail/password?mobile=string&mobile_code=string&password=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

我的资料

GET/api/v2/member/profile

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.real_namestring必填
  真实姓名
- data.genderstring必填
  性别[1:男,2:女,0:未公开]
- data.agestring必填
  年龄
- data.birthdaystring必填
  生日
- data.professionstring必填
  职业
- data.addressstring必填
  住址
- data.graduated_schoolstring必填
  毕业院校
- data.diplomastring必填
  毕业证照片
- data.id_numberstring必填
  身份证号
- data.id_frontend_thumbstring必填
  身份证人像面
- data.id_backend_thumbstring必填
  身份证国徽面
- data.id_hand_thumbstring必填
  手持身份证照片

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/profile?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "real_name": "string",
5    "gender": "string",
6    "age": "string",
7    "birthday": "string",
8    "profession": "string",
9    "address": "string",
10    "graduated_school": "string",
11    "diploma": "string",
12    "id_number": "string",
13    "id_frontend_thumb": "string",
14    "id_backend_thumb": "string",
15    "id_hand_thumb": "string"
16  }
17}

资料编辑

POST/api/v2/member/profile

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

real_namestring
真实姓名
genderstring
性别[1:男,2:女,0:未公开]
agestring
年龄
birthdaystring
生日
professionstring
职业
addressstring
住址
graduated_schoolstring
毕业院校
diplomastring
毕业证照片
id_numberstring
身份证号
id_frontend_thumbstring
身份证人像面
id_backend_thumbstring
身份证国徽面
id_hand_thumbstring
手持身份证照片

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/profile?real_name=string&gender=string&age=string&birthday=string&profession=string&address=string&graduated_school=string&diploma=string&id_number=string&id_frontend_thumb=string&id_backend_thumb=string&id_hand_thumb=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

VIP订购记录

GET/api/v2/member/roles

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
- 数组成员object
- data.idnumber必填
  记录ID
- data.user_idnumber必填
  用户ID
- data.role_Idnumber必填
  VIPid
- data.chargenumber必填
  订购价格
- data.started_atstring必填
  开始时间
- data.expired_atstring必填
  结束时间
- data.roleobject必填
  - 子属性
  - role.namenumber必填
    VIP名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/roles?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "user_id": "fake_simple_value",
7      "role_Id": "fake_simple_value",
8      "charge": "fake_simple_value",
9      "started_at": "string",
10      "expired_at": "string",
11      "role": {
12        "name": "fake_simple_value"
13      }
14    }
15  ]
16}

社交账号绑定[302重定向]

app={qq:QQ登录}

GET/api/v2/member/socialite/{app}

请求 Request

QUERY

tokenstring必填
登录token
redirect_urlstring必填
绑定成功之后的跳转地址，需要urlEncode

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/socialite/{app}?token=string&redirect_url=string

社交登录解绑

app={qq:QQ登录,wechat:微信}

DELETE/api/v2/member/socialite/{app}

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.codestring必填
  随机值
- data.imagestring必填
  图片内容

Example 1

请求示例

文本

DELETE

{{BASE_URL}}/api/v2/member/socialite/{app}

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code": "string",
5    "image": "string"
6  }
7}

未读消息数量

GET/api/v2/member/unreadNotificationCount

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
datanumber
未读消息数量

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/unreadNotificationCount

成功示例

1{
2  "code": "fake_simple_value",
3  "data": "fake_simple_value"
4}

校验

POST/api/v2/member/verify

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

mobilestring必填
手机号
mobile_codestring必填
短信验证码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.signstring必填
  校验字符串

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/member/verify?mobile=string&mobile_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "sign": "string"
5  }
6}

已购视频

GET/api/v2/member/videos

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

pagenumber
page
page_sizenumber
size

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.totalnumber必填
  总数
- data.dataarray必填
  - 数组成员object
  - data.idnumber必填
    视频ID
  - data.titlestring必填
    视频名
  - data.chargenumber必填
    视频价格
  - data.view_numnumber必填
    观看数[已废弃]
  - data.short_descriptionstring必填
    简短介绍
  - data.render_descstring必填
    详细介绍[已废弃]
  - data.published_atstring必填
    上架时间
  - data.durationnumber必填
    时长[单位：秒]
  - data.seo_keywordsstring必填
    SEO关键字
  - data.seo_descriptionstring必填
    SEO描述
  - data.is_ban_sellnumber必填
    禁止出售[1:是,0否]
  - data.chapter_idnumber必填
    章节ID

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/videos?page=fake_simple_value&page_size=fake_simple_value

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "total": "fake_simple_value",
5    "data": [
6      {
7        "id": "fake_simple_value",
8        "title": "string",
9        "charge": "fake_simple_value",
10        "view_num": "fake_simple_value",
11        "short_description": "string",
12        "render_desc": "string",
13        "published_at": "string",
14        "duration": "fake_simple_value",
15        "seo_keywords": "string",
16        "seo_description": "string",
17        "is_ban_sell": "fake_simple_value",
18        "chapter_id": "fake_simple_value"
19      }
20    ]
21  }
22}

微信扫码绑定[二维码]

GET/api/v2/member/wechatScan/bind

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.codestring必填
  随机值
- data.imagestring必填
  图片内容

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/wechatScan/bind

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code": "string",
5    "image": "string"
6  }
7}

微信公众号授权绑定[302重定向]

GET/api/v2/member/wechatBind

请求 Request

QUERY

tokenstring必填
登录token
redirect_urlstring必填
绑定成功之后的跳转地址，需要urlEncode

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/member/wechatBind?token=string&redirect_url=string

装修界面

页面装修模块

GET/api/v2/viewBlock/page/blocks

请求 Request

QUERY

platformstring必填
平台[APP,H5,PC,MINI]
page_namestring必填
页面标识

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataarray
数据
- 数组成员object
- data.idnumber必填
  记录ID
- data.platformstring必填
  平台
- data.page_namestring必填
  所属页面
- data.signstring必填
  模块特征值
- data.sortnumber必填
  升序
- data.configstring必填
  配置(经过json_encode的字符串)
- data.config_renderobject必填
  配置(已转码)

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/viewBlock/page/blocks?platform=string&page_name=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": [
4    {
5      "id": "fake_simple_value",
6      "platform": "string",
7      "page_name": "string",
8      "sign": "string",
9      "sort": "fake_simple_value",
10      "config": "string",
11      "config_render": {}
12    }
13  ]
14}

订单-V3

手动打款支付

GET/api/v3/order/pay/handPay

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

order_idstring必填
订单编号

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.textstring必填
  手动打款支付信息

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v3/order/pay/handPay?order_id=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "text": "string"
5  }
6}

订单

订单状态查询

GET/api/v2/order/status

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

order_idstring必填
订单编号

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.statusnumber必填
  订单状态[1:未支付,5:支付中,9:已支付,7:已取消]

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/order/status?order_id=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "status": "fake_simple_value"
5  }
6}

跳转到第三方支付

GET/api/v2/order/pay/redirect

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

payment_scenestring必填
可选值：h5:手机浏览器 , wechat:微信浏览器
支付场景
paymentstring必填
可选值：alipay:支付宝支付 , wechat-jsapi:微信jsapi支付 , handPay:手动打款
支付方式
order_idstring必填
订单编号
redirectstring必填
支付完成回跳地址

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/order/pay/redirect?payment_scene=h5%3A%E6%89%8B%E6%9C%BA%E6%B5%8F%E8%A7%88%E5%99%A8&payment=alipay%3A%E6%94%AF%E4%BB%98%E5%AE%9D%E6%94%AF%E4%BB%98&order_id=string&redirect=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {}
4}

手动打款支付

GET/api/v2/order/pay/handPay

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.textstring必填
  手动打款支付信息

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/order/pay/handPay

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "text": "string"
5  }
6}

微信扫码支付[PC]

POST/api/v2/order/pay/wechatScan

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

order_idstring必填
订单编号

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.code_urlstring必填
  微信支付二维码的文本值，用该值生成二维码

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/order/pay/wechatScan?order_id=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "code_url": "string"
5  }
6}

支付网关列表

GET/api/v2/order/payments

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

scenestring必填
支付场景[h5,wechat]

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.signstring必填
  网关值
- data.namestring必填
  网关名

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/order/payments?scene=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "sign": "string",
5    "name": "string"
6  }
7}

优惠码检测

GET/api/v2/promoCode/{code}/check

请求 Request

QUERY

codestring必填
优惠码/邀请码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.can_usenumber必填
  是否可以使用[1:可以,0否]
- data.promo_codeobject必填
  - 子属性
  - promo_code.idnumber必填
  - promo_code.codestring必填
    优惠码/邀请码
  - promo_code.expired_atstring必填
    过期时间
  - promo_code.invited_user_rewardnumber必填
    被邀请用户奖励

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/promoCode/{code}/check?code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "can_use": "fake_simple_value",
5    "promo_code": {
6      "id": "fake_simple_value",
7      "code": "string",
8      "expired_at": "string",
9      "invited_user_reward": "fake_simple_value"
10    }
11  }
12}

优惠码详情

GET/api/v2/promoCode/{code}

请求 Request

QUERY

codestring必填
优惠码/邀请码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
数据
- 子属性
- data.idnumber必填
- data.codestring必填
  优惠码/邀请码
- data.expired_atstring必填
  过期时间
- data.invited_user_rewardnumber必填
  被邀请用户奖励
- data.invite_user_rewardnumber必填
  邀请用户奖励

Example 1

请求示例

文本

GET

{{BASE_URL}}/api/v2/promoCode/{code}?code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "code": "string",
6    "expired_at": "string",
7    "invited_user_reward": "fake_simple_value",
8    "invite_user_reward": "fake_simple_value"
9  }
10}

创建录播课程订单

POST/api/v2/order/course

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

course_idnumber必填
录播课程ID
promo_codestring
优惠码/邀请码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.idnumber必填
  订单ID
- data.user_idnumber必填
  用户ID
- data.chargenumber必填
  价格
- data.order_idstring必填
  订单编号
- data.payment_methodstring必填
  支付渠道
- data.payment_textstring必填
  支付方法
- data.status_textstring必填
  状态
- data.continue_paynumber必填
  继续支付[已废弃]
- data.goodsobject必填
  - 子属性
  - goods.idnumber必填
    记录ID
  - goods.goods_textstring必填
    商品名
  - goods.goods_typestring必填
    商品类型
  - goods.numnumber必填
    数量
  - goods.chargenumber必填
    价格
- data.created_atstring必填
  时间

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/order/course?course_id=fake_simple_value&promo_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "user_id": "fake_simple_value",
6    "charge": "fake_simple_value",
7    "order_id": "string",
8    "payment_method": "string",
9    "payment_text": "string",
10    "status_text": "string",
11    "continue_pay": "fake_simple_value",
12    "goods": {
13      "id": "fake_simple_value",
14      "goods_text": "string",
15      "goods_type": "string",
16      "num": "fake_simple_value",
17      "charge": "fake_simple_value"
18    },
19    "created_at": "string"
20  }
21}

创建VIP订单

POST/api/v2/order/role

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

role_idnumber必填
VIPid
promo_codestring
优惠码/邀请码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.idnumber必填
  订单ID
- data.user_idnumber必填
  用户ID
- data.chargenumber必填
  价格
- data.order_idstring必填
  订单编号
- data.payment_methodstring必填
  支付渠道
- data.payment_textstring必填
  支付方法
- data.status_textstring必填
  状态
- data.continue_paynumber必填
  继续支付[已废弃]
- data.goodsobject必填
  - 子属性
  - goods.idnumber必填
    记录ID
  - goods.goods_textstring必填
    商品名
  - goods.goods_typestring必填
    商品类型
  - goods.numnumber必填
    数量
  - goods.chargenumber必填
    价格
- data.created_atstring必填
  时间

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/order/role?role_id=fake_simple_value&promo_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "user_id": "fake_simple_value",
6    "charge": "fake_simple_value",
7    "order_id": "string",
8    "payment_method": "string",
9    "payment_text": "string",
10    "status_text": "string",
11    "continue_pay": "fake_simple_value",
12    "goods": {
13      "id": "fake_simple_value",
14      "goods_text": "string",
15      "goods_type": "string",
16      "num": "fake_simple_value",
17      "charge": "fake_simple_value"
18    },
19    "created_at": "string"
20  }
21}

创建视频订单[v4.8-移除]

POST/api/v2/order/video

请求 Request

HEADER

Authorizationstring必填
Bearer+空格+token

QUERY

video_idnumber必填
videoID
promo_codestring
优惠码/邀请码

响应 Response

状态码 200

参数

codenumber
0成功,非0失败
dataobject
- 子属性
- data.idnumber必填
  订单ID
- data.user_idnumber必填
  用户ID
- data.chargenumber必填
  价格
- data.order_idstring必填
  订单编号
- data.payment_methodstring必填
  支付渠道
- data.payment_textstring必填
  支付方法
- data.status_textstring必填
  状态
- data.continue_paynumber必填
  继续支付[已废弃]
- data.goodsobject必填
  - 子属性
  - goods.idnumber必填
    记录ID
  - goods.goods_textstring必填
    商品名
  - goods.goods_typestring必填
    商品类型
  - goods.numnumber必填
    数量
  - goods.chargenumber必填
    价格
- data.created_atstring必填
  时间

Example 1

请求示例

文本

POST

{{BASE_URL}}/api/v2/order/video?video_id=fake_simple_value&promo_code=string

成功示例

1{
2  "code": "fake_simple_value",
3  "data": {
4    "id": "fake_simple_value",
5    "user_id": "fake_simple_value",
6    "charge": "fake_simple_value",
7    "order_id": "string",
8    "payment_method": "string",
9    "payment_text": "string",
10    "status_text": "string",
11    "continue_pay": "fake_simple_value",
12    "goods": {
13      "id": "fake_simple_value",
14      "goods_text": "string",
15      "goods_type": "string",
16      "num": "fake_simple_value",
17      "charge": "fake_simple_value"
18    },
19    "created_at": "string"
20  }
21}

meedu v2

Auth-V3

.css-wjdogd{-webkit-text-decoration:initial;text-decoration:initial;}社交账号登录

QUERY

参数

Example 1

请求示例

成功示例

微信公众号授权登录

QUERY

参数

Example 1

请求示例

成功示例

微信公众号扫码登录

参数

Example 1

成功示例

微信公众号扫码登录结果查询

QUERY

参数

Example 1

请求示例

成功示例

三方账号登录

QUERY

参数

Example 1

请求示例

成功示例

社交账号注册[绑定手机号]

QUERY

参数

Example 1

请求示例

成功示例

微信扫码注册[绑定手机号]

QUERY

参数

Example 1

请求示例

成功示例

Auth

安全退出

参数

Example 1

成功示例

短信登录

QUERY

参数

Example 1

请求示例

成功示例

密码登录

QUERY

参数

Example 1

请求示例

成功示例

社交APP登录[重定向]

QUERY

参数

Example 1

请求示例

成功示例

微信扫码登录[二维码]

参数

Example 1

成功示例

微信扫码登录[结果查询]

QUERY

参数

Example 1

请求示例

成功示例

重置密码

QUERY

参数

Example 1

请求示例

社交账号登录