meedu v2

meedu api v2.

基础路径

API BASE URL

  • http://127.0.0.1:8000/api/v2
    local

MeEdu Api v2.

项目地址：https://github.com/Qsnh/meedu

官网：https://meedu.vip

api统一前缀：/api/v2

登录授权：

需要登录的接口请在api请求头中增加这个字段：

Authorization: Bearer token

注意：其中的token是请求登录接口返回的。

API REFERENCE

课程

课程相关接口

课程分类

get/course_categories
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataarray
    • 数组成员object
    • data.idint

      id

    • data.namestring

      分类名

    • data.parent_idint

      父id

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
{
  "code": 3,
  "message": "string",
  "data": [
    {
      "id": 3,
      "name": "string",
      "parent_id": 3
    }
  ]
}

课程列表

get/courses
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

  • category_idint

    分类id

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      数据列表

      • 数组成员object
      • data.idint

        课程id

      • data.titlestring

        课程标题

      • data.slugstring

        slug

      • data.thumbstring

        课程封面

      • data.chargeint

        课程价格

      • data.short_descriptionstring

        简短介绍

      • data.render_descstring

        详细介绍

      • data.published_atstring

        上线时间

      • data.seo_keywordsstring

        seo_keywords

      • data.seo_descriptionstring

        seo_description

      • data.category_idint

        分类id

      • data.is_recint

        推荐

      • data.user_countint

        订阅人数

      • data.videos_countint

        视频数量

      • data.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "id": 3,
        "title": "string",
        "slug": "string",
        "thumb": "string",
        "charge": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "seo_keywords": "string",
        "seo_description": "string",
        "category_id": 3,
        "is_rec": 3,
        "user_count": 3,
        "videos_count": 3,
        "category": {
          "id": 3,
          "name": "string",
          "parent_id": 3
        }
      }
    ]
  }
}

课程信息

get/course/{id}
请求 Request

路由参数

  • idint
    课程id
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.courseobject

      课程

      • 子属性
      • course.idint

        课程id

      • course.titlestring

        课程标题

      • course.slugstring

        slug

      • course.thumbstring

        课程封面

      • course.chargeint

        课程价格

      • course.short_descriptionstring

        简短介绍

      • course.render_descstring

        详细介绍

      • course.published_atstring

        上线时间

      • course.seo_keywordsstring

        seo_keywords

      • course.seo_descriptionstring

        seo_description

      • course.category_idint

        分类id

      • course.is_recint

        推荐

      • course.user_countint

        订阅人数

      • course.videos_countint

        视频数量

      • course.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

    • data.chaptersarray

      课程章节

      • 数组成员object
      • chapters.idint

        id

      • chapters.course_idint

        课程id

      • chapters.titlestring

        章节名

    • data.videosarray

      视频

      • 数组成员object
      • videos.idint

        id

      • videos.course_idint

        课程id

      • videos.titlestring

        视频标题

      • videos.slugstring

        slug

      • videos.chargeint

        视频价格

      • videos.view_numint

        观看次数

      • videos.short_descriptionstring

        简短介绍

      • videos.render_descstring

        详细介绍

      • videos.published_atstring

        上线时间

      • videos.durationint

        视频时长，单位：秒

      • videos.seo_keywordsint

        seo_keywords

      • videos.seo_descriptionint

        seo_description

      • videos.chapter_idint

        章节id

    • data.isBuystring

      是否购买

Example 1

成功示例

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
43
44
45
46
47
48
49
50
51
52
{
  "code": 3,
  "message": "string",
  "data": {
    "course": {
      "id": 3,
      "title": "string",
      "slug": "string",
      "thumb": "string",
      "charge": 3,
      "short_description": "string",
      "render_desc": "string",
      "published_at": "string",
      "seo_keywords": "string",
      "seo_description": "string",
      "category_id": 3,
      "is_rec": 3,
      "user_count": 3,
      "videos_count": 3,
      "category": {
        "id": 3,
        "name": "string",
        "parent_id": 3
      }
    },
    "chapters": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string"
      }
    ],
    "videos": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string",
        "slug": "string",
        "charge": 3,
        "view_num": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "duration": 3,
        "seo_keywords": 3,
        "seo_description": 3,
        "chapter_id": 3
      }
    ],
    "isBuy": "string"
  }
}

课程评论

post/course/{id}/comment
请求 Request

路由参数

  • idint
    课程id

请求 BODY

  • contentstring

    评论内容

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

课程评论列表

get/course/{id}/comments
请求 Request

路由参数

  • idint
    课程id

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.commentsarray

      评论

      • 数组成员object
      • comments.idint

        id

      • comments.user_idint

        用户id

      • comments.render_contentstring

        评论内容

      • comments.created_atstring

        时间

    • data.usersarray

      评论用户

      • 数组成员object
      • users.idint

        用户id

      • users.avatarstring

        头像

      • users.nick_namestring

        昵称

      • users.mobilestring

        手机号

      • users.role_idint

        会员套餐id

      • users.role_expired_atstring

        会员套餐到期时间

      • users.roleobject

        会员套餐

        • 子属性
        • role.idint

          套餐id

        • role.namestring

          套餐名

        • role.chargeint

          套餐价格

        • role.expire_daysint

          套餐天数

        • role.desc_rowsarray

          套餐描述

          • 数组成员object
      • users.invite_balanceint

        邀请余额

      • users.is_password_setint

        是否配置了密码

      • users.is_set_nicknameint

        是否设置了昵称

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "comments": [
      {
        "id": 3,
        "user_id": 3,
        "render_content": "string",
        "created_at": "string"
      }
    ],
    "users": [
      {
        "id": 3,
        "avatar": "string",
        "nick_name": "string",
        "mobile": "string",
        "role_id": 3,
        "role_expired_at": "string",
        "role": {
          "id": 3,
          "name": "string",
          "charge": 3,
          "expire_days": 3,
          "desc_rows": [
            {
              "": "string"
            }
          ]
        },
        "invite_balance": 3,
        "is_password_set": 3,
        "is_set_nickname": 3
      }
    ]
  }
}

视频

视频相关接口

视频列表

get/videos
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      数据列表

      • 数组成员object
      • data.idint

        id

      • data.course_idint

        课程id

      • data.titlestring

        视频标题

      • data.slugstring

        slug

      • data.chargeint

        视频价格

      • data.view_numint

        观看次数

      • data.short_descriptionstring

        简短介绍

      • data.render_descstring

        详细介绍

      • data.published_atstring

        上线时间

      • data.durationint

        视频时长，单位：秒

      • data.seo_keywordsint

        seo_keywords

      • data.seo_descriptionint

        seo_description

      • data.chapter_idint

        章节id

Example 1

成功示例

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": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string",
        "slug": "string",
        "charge": 3,
        "view_num": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "duration": 3,
        "seo_keywords": 3,
        "seo_description": 3,
        "chapter_id": 3
      }
    ]
  }
}

视频信息

get/video/{id}
请求 Request

路由参数

  • idint
    视频id
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.videoobject

      视频

      • 子属性
      • video.idint

        id

      • video.course_idint

        课程id

      • video.titlestring

        视频标题

      • video.slugstring

        slug

      • video.chargeint

        视频价格

      • video.view_numint

        观看次数

      • video.short_descriptionstring

        简短介绍

      • video.render_descstring

        详细介绍

      • video.published_atstring

        上线时间

      • video.durationint

        视频时长，单位：秒

      • video.seo_keywordsint

        seo_keywords

      • video.seo_descriptionint

        seo_description

      • video.chapter_idint

        章节id

    • data.chaptersarray

      课程章节

      • 数组成员object
      • chapters.idint

        id

      • chapters.course_idint

        课程id

      • chapters.titlestring

        章节名

    • data.videosarray

      视频列表

      • 数组成员object
      • videos.idint

        id

      • videos.course_idint

        课程id

      • videos.titlestring

        视频标题

      • videos.slugstring

        slug

      • videos.chargeint

        视频价格

      • videos.view_numint

        观看次数

      • videos.short_descriptionstring

        简短介绍

      • videos.render_descstring

        详细介绍

      • videos.published_atstring

        上线时间

      • videos.durationint

        视频时长，单位：秒

      • videos.seo_keywordsint

        seo_keywords

      • videos.seo_descriptionint

        seo_description

      • videos.chapter_idint

        章节id

    • data.courseobject

      课程

      • 子属性
      • course.idint

        课程id

      • course.titlestring

        课程标题

      • course.slugstring

        slug

      • course.thumbstring

        课程封面

      • course.chargeint

        课程价格

      • course.short_descriptionstring

        简短介绍

      • course.render_descstring

        详细介绍

      • course.published_atstring

        上线时间

      • course.seo_keywordsstring

        seo_keywords

      • course.seo_descriptionstring

        seo_description

      • course.category_idint

        分类id

      • course.is_recint

        推荐

      • course.user_countint

        订阅人数

      • course.videos_countint

        视频数量

      • course.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

    • data.is_watchboolean

      是否可以观看

Example 1

成功示例

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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
{
  "code": 3,
  "message": "string",
  "data": {
    "video": {
      "id": 3,
      "course_id": 3,
      "title": "string",
      "slug": "string",
      "charge": 3,
      "view_num": 3,
      "short_description": "string",
      "render_desc": "string",
      "published_at": "string",
      "duration": 3,
      "seo_keywords": 3,
      "seo_description": 3,
      "chapter_id": 3
    },
    "chapters": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string"
      }
    ],
    "videos": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string",
        "slug": "string",
        "charge": 3,
        "view_num": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "duration": 3,
        "seo_keywords": 3,
        "seo_description": 3,
        "chapter_id": 3
      }
    ],
    "course": {
      "id": 3,
      "title": "string",
      "slug": "string",
      "thumb": "string",
      "charge": 3,
      "short_description": "string",
      "render_desc": "string",
      "published_at": "string",
      "seo_keywords": "string",
      "seo_description": "string",
      "category_id": 3,
      "is_rec": 3,
      "user_count": 3,
      "videos_count": 3,
      "category": {
        "id": 3,
        "name": "string",
        "parent_id": 3
      }
    },
    "is_watch": true
  }
}

视频评论

post/video/{id}/comment
请求 Request

路由参数

  • idint
    视频id

请求 BODY

  • contentstring

    评论内容

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

视频评论列表

get/video/{id}/comments
请求 Request

路由参数

  • idint
    视频id

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.commentsarray

      评论

      • 数组成员object
      • comments.idint

        id

      • comments.user_idint

        用户id

      • comments.render_contentstring

        评论内容

      • comments.created_atstring

        时间

    • data.usersarray

      评论用户

      • 数组成员object
      • users.idint

        用户id

      • users.avatarstring

        头像

      • users.nick_namestring

        昵称

      • users.mobilestring

        手机号

      • users.role_idint

        会员套餐id

      • users.role_expired_atstring

        会员套餐到期时间

      • users.roleobject

        会员套餐

        • 子属性
        • role.idint

          套餐id

        • role.namestring

          套餐名

        • role.chargeint

          套餐价格

        • role.expire_daysint

          套餐天数

        • role.desc_rowsarray

          套餐描述

          • 数组成员object
      • users.invite_balanceint

        邀请余额

      • users.is_password_setint

        是否配置了密码

      • users.is_set_nicknameint

        是否设置了昵称

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "comments": [
      {
        "id": 3,
        "user_id": 3,
        "render_content": "string",
        "created_at": "string"
      }
    ],
    "users": [
      {
        "id": 3,
        "avatar": "string",
        "nick_name": "string",
        "mobile": "string",
        "role_id": 3,
        "role_expired_at": "string",
        "role": {
          "id": 3,
          "name": "string",
          "charge": 3,
          "expire_days": 3,
          "desc_rows": [
            {
              "": "string"
            }
          ]
        },
        "invite_balance": 3,
        "is_password_set": 3,
        "is_set_nickname": 3
      }
    ]
  }
}

视频播放地址

get/video/{id}/playinfo
请求 Request

路由参数

  • idint
    视频id
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.urlsarray

      播放地址

      • 数组成员object
      • urls.urlstring

        视频播放地址

      • urls.formatstring

        视频格式

      • urls.durationint

        时长，秒

      • urls.namestring

        码率

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "code": 3,
  "message": "string",
  "data": {
    "urls": [
      {
        "url": "string",
        "format": "string",
        "duration": 3,
        "name": "string"
      }
    ]
  }
}

视频观看时长记录

post/video/{id}/record
请求 Request

路由参数

  • idint
    视频id

请求 BODY

  • durationint

    时长

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

用户

用户相关接口

用户信息

get/member/detail
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    用户信息

    • 子属性
    • data.idint

      用户id

    • data.avatarstring

      头像

    • data.nick_namestring

      昵称

    • data.mobilestring

      手机号

    • data.role_idint

      会员套餐id

    • data.role_expired_atstring

      会员套餐到期时间

    • data.roleobject

      会员套餐

      • 子属性
      • role.idint

        套餐id

      • role.namestring

        套餐名

      • role.chargeint

        套餐价格

      • role.expire_daysint

        套餐天数

      • role.desc_rowsarray

        套餐描述

        • 数组成员object
    • data.invite_balanceint

      邀请余额

    • data.is_password_setint

      是否配置了密码

    • data.is_set_nicknameint

      是否设置了昵称

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "id": 3,
    "avatar": "string",
    "nick_name": "string",
    "mobile": "string",
    "role_id": 3,
    "role_expired_at": "string",
    "role": {
      "id": 3,
      "name": "string",
      "charge": 3,
      "expire_days": 3,
      "desc_rows": [
        {
          "": "string"
        }
      ]
    },
    "invite_balance": 3,
    "is_password_set": 3,
    "is_set_nickname": 3
  }
}

修改密码

post/member/password
请求 Request

请求 BODY

  • mobilestring

    手机号

  • mobile_codestring

    手机短信验证码

  • passwordstring

    密码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

更换手机号

post/member/mobile
请求 Request

请求 BODY

  • mobilestring

    手机号

  • mobile_codestring

    手机短信验证码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

修改昵称

post/member/nickname
请求 Request

请求 BODY

  • nick_namestring

    昵称

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

修改头像

post/member/avatar
请求 Request

请求 BODY

  • fileobject

    图片文件

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

用户订购套餐信息

get/member/roles
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.listarray

      列表

      • 数组成员object
      • list.user_idint

        用户id

      • list.role_idint

        套餐id

      • list.chargeint

        购买时价格

      • list.started_atstring

        开始时间

      • list.expired_atstring

        结束时间

      • list.roleobject

        会员套餐

        套餐

        • 子属性
        • role.idint

          套餐id

        • role.namestring

          套餐名

        • role.chargeint

          套餐价格

        • role.expire_daysint

          套餐天数

        • role.desc_rowsarray

          套餐描述

          • 数组成员object

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "list": [
      {
        "user_id": 3,
        "role_id": 3,
        "charge": 3,
        "started_at": "string",
        "expired_at": "string",
        "role": {
          "id": 3,
          "name": "string",
          "charge": 3,
          "expire_days": 3,
          "desc_rows": [
            {
              "": "string"
            }
          ]
        }
      }
    ]
  }
}

用户消息

get/member/messages
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.listarray

      列表

      • 数组成员object
      • list.idstring

        消息id

      • list.notifiable_idint

        notifiable_id

      • list.read_atstring

        read_at

      • list.created_atstring

        created_at

      • list.dataarray
        • 数组成员object

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "list": [
      {
        "id": "string",
        "notifiable_id": 3,
        "read_at": "string",
        "created_at": "string",
        "data": [
          {
            "": "string"
          }
        ]
      }
    ]
  }
}

用户课程

get/member/courses
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.user_idint

        用户id

      • data.course_idint

        课程id

      • data.chargeint

        购买时价格

      • data.created_atstring

        购买时间

    • data.coursesarray

      课程

      • 数组成员object
      • courses.idint

        课程id

      • courses.titlestring

        课程标题

      • courses.slugstring

        slug

      • courses.thumbstring

        课程封面

      • courses.chargeint

        课程价格

      • courses.short_descriptionstring

        简短介绍

      • courses.render_descstring

        详细介绍

      • courses.published_atstring

        上线时间

      • courses.seo_keywordsstring

        seo_keywords

      • courses.seo_descriptionstring

        seo_description

      • courses.category_idint

        分类id

      • courses.is_recint

        推荐

      • courses.user_countint

        订阅人数

      • courses.videos_countint

        视频数量

      • courses.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "user_id": 3,
        "course_id": 3,
        "charge": 3,
        "created_at": "string"
      }
    ],
    "courses": [
      {
        "id": 3,
        "title": "string",
        "slug": "string",
        "thumb": "string",
        "charge": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "seo_keywords": "string",
        "seo_description": "string",
        "category_id": 3,
        "is_rec": 3,
        "user_count": 3,
        "videos_count": 3,
        "category": {
          "id": 3,
          "name": "string",
          "parent_id": 3
        }
      }
    ]
  }
}

用户收藏课程

get/member/courses/like
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.user_idint

        用户id

      • data.course_idint

        课程id

      • data.chargeint

        购买时价格

      • data.created_atstring

        购买时间

    • data.coursesarray

      课程

      • 数组成员object
      • courses.idint

        课程id

      • courses.titlestring

        课程标题

      • courses.slugstring

        slug

      • courses.thumbstring

        课程封面

      • courses.chargeint

        课程价格

      • courses.short_descriptionstring

        简短介绍

      • courses.render_descstring

        详细介绍

      • courses.published_atstring

        上线时间

      • courses.seo_keywordsstring

        seo_keywords

      • courses.seo_descriptionstring

        seo_description

      • courses.category_idint

        分类id

      • courses.is_recint

        推荐

      • courses.user_countint

        订阅人数

      • courses.videos_countint

        视频数量

      • courses.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "user_id": 3,
        "course_id": 3,
        "charge": 3,
        "created_at": "string"
      }
    ],
    "courses": [
      {
        "id": 3,
        "title": "string",
        "slug": "string",
        "thumb": "string",
        "charge": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "seo_keywords": "string",
        "seo_description": "string",
        "category_id": 3,
        "is_rec": 3,
        "user_count": 3,
        "videos_count": 3,
        "category": {
          "id": 3,
          "name": "string",
          "parent_id": 3
        }
      }
    ]
  }
}

用户已学习课程

get/member/courses/history
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.user_idint

        用户id

      • data.course_idint

        课程id

      • data.chargeint

        购买时价格

      • data.created_atstring

        购买时间

    • data.coursesarray

      课程

      • 数组成员object
      • courses.idint

        课程id

      • courses.titlestring

        课程标题

      • courses.slugstring

        slug

      • courses.thumbstring

        课程封面

      • courses.chargeint

        课程价格

      • courses.short_descriptionstring

        简短介绍

      • courses.render_descstring

        详细介绍

      • courses.published_atstring

        上线时间

      • courses.seo_keywordsstring

        seo_keywords

      • courses.seo_descriptionstring

        seo_description

      • courses.category_idint

        分类id

      • courses.is_recint

        推荐

      • courses.user_countint

        订阅人数

      • courses.videos_countint

        视频数量

      • courses.categoryobject

        课程分类

        • 子属性
        • category.idint

          id

        • category.namestring

          分类名

        • category.parent_idint

          父id

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "user_id": 3,
        "course_id": 3,
        "charge": 3,
        "created_at": "string"
      }
    ],
    "courses": [
      {
        "id": 3,
        "title": "string",
        "slug": "string",
        "thumb": "string",
        "charge": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "seo_keywords": "string",
        "seo_description": "string",
        "category_id": 3,
        "is_rec": 3,
        "user_count": 3,
        "videos_count": 3,
        "category": {
          "id": 3,
          "name": "string",
          "parent_id": 3
        }
      }
    ]
  }
}

用户课程

get/member/videos
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.user_idint

        用户id

      • data.video_idint

        视频id

      • data.chargeint

        购买时价格

      • data.created_atstring

        购买时间

    • data.videosarray

      视频

      • 数组成员object
      • videos.idint

        id

      • videos.course_idint

        课程id

      • videos.titlestring

        视频标题

      • videos.slugstring

        slug

      • videos.chargeint

        视频价格

      • videos.view_numint

        观看次数

      • videos.short_descriptionstring

        简短介绍

      • videos.render_descstring

        详细介绍

      • videos.published_atstring

        上线时间

      • videos.durationint

        视频时长，单位：秒

      • videos.seo_keywordsint

        seo_keywords

      • videos.seo_descriptionint

        seo_description

      • videos.chapter_idint

        章节id

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "user_id": 3,
        "video_id": 3,
        "charge": 3,
        "created_at": "string"
      }
    ],
    "videos": [
      {
        "id": 3,
        "course_id": 3,
        "title": "string",
        "slug": "string",
        "charge": 3,
        "view_num": 3,
        "short_description": "string",
        "render_desc": "string",
        "published_at": "string",
        "duration": 3,
        "seo_keywords": 3,
        "seo_description": 3,
        "chapter_id": 3
      }
    ]
  }
}

用户订单

get/member/orders
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.idint

        id

      • data.user_idint

        用户id

      • data.chargeint

        总价

      • data.order_idstring

        订单编号

      • data.payment_methodstring

        支付方式

      • data.payment_textstring

        支付渠道文本

      • data.continue_payboolean

        是否可以继续支付

      • data.goodsarray

        商品

        • 数组成员object
        • goods.numint

          订购数量

        • goods.goods_textint

          商品名

        • goods.chargestring

          价格

        • goods.goods_typestring

          商品类型

      • data.status_textstring

        状态文本

      • data.created_atstring

        时间

Example 1

成功示例

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
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "id": 3,
        "user_id": 3,
        "charge": 3,
        "order_id": "string",
        "payment_method": "string",
        "payment_text": "string",
        "continue_pay": true,
        "goods": [
          {
            "num": 3,
            "goods_text": 3,
            "charge": "string",
            "goods_type": "string"
          }
        ],
        "status_text": "string",
        "created_at": "string"
      }
    ]
  }
}

用户邀请余额明细

get/member/inviteBalanceRecrods
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.totalint

        金额

      • data.descstring

        说明

      • data.created_atint

        时间

Example 1

成功示例

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

用户邀请码

get/member/promoCode
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    优惠码

    • 子属性
    • data.idint

      id

    • data.codestring

      优惠码

    • data.expired_atstring

      过期时间

    • data.invited_user_rewardint

      被邀请奖励

Example 1

成功示例

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

生成用户邀请码

post/member/promoCode
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

消息标记已读

get/member/notificationMarkAsRead/{notificationId}
请求 Request

路由参数

  • notificationIdstring
    消息id
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

消息全部标记已读

get/member/notificationMarkAllAsRead
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

我的邀请用户

get/member/inviteUsers
请求 Request

QUERY

  • pageint

    页码

  • page_sizeint

    每页数量

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.mobileint

        手机号

      • data.created_atstring

        时间

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "code": 3,
  "message": "string",
  "data": {
    "total": 3,
    "data": [
      {
        "mobile": 3,
        "created_at": "string"
      }
    ]
  }
}

邀请余额提现记录

get/member/withdrawRecords
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.totalint

      总数

    • data.dataarray

      列表

      • 数组成员object
      • data.status_textint

        提现状态

      • data.created_atstring

        时间

      • data.remarkstring

        备注

      • data.totalint

        提现金额

Example 1

成功示例

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

邀请余额提现

post/member/withdraw
请求 Request

请求 BODY

  • channelstring

    渠道

  • channel_namestring

    姓名

  • channel_accountstring

    账号

  • totalint

    提现金额

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

Auth

登录/注册相关接口

密码登录

post/login/password
请求 Request

请求 BODY

  • mobilestring

    手机号

  • passwordstring

    密码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.tokenstring

      token

Example 1

成功示例

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

手机短信登录

post/login/mobile
请求 Request

请求 BODY

  • mobilestring

    手机号

  • mobile_codestring

    手机验证码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.tokenstring

      token

Example 1

成功示例

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

手机号注册

post/register/mobile
请求 Request

请求 BODY

  • mobilestring

    手机号

  • mobile_codestring

    手机验证码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

微信小程序静默登录

post/wechat/mini/login
请求 Request

请求 BODY

  • codestring

    code

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.openidstring

      openid

    • data.session_keystring

      session_key

Example 1

成功示例

1
2
3
4
5
6
7
8
{
  "code": 3,
  "message": "string",
  "data": {
    "openid": "string",
    "session_key": "string"
  }
}

其它

其它接口

图形验证码

post/captcha/image
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.keystring

      key

    • data.imgstring

      图片内容

Example 1

成功示例

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

发送手机验证码

post/captcha/sms
请求 Request

请求 BODY

  • mobilestring

    手机号

  • image_captchastring

    图形验证码

  • image_keystring

    图形验证码key

  • scenestring

    scene[login:登录,register:注册,password_reset:密码重置]

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

系统配置

get/other/config
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    系统配置

    • 子属性
    • data.webnamestring

      网站名

    • data.icpstring

      备案信息

    • data.user_protocolstring

      用户协议url

    • data.aboutusint

      关于我们url

    • data.logoobject

      logo

      • 子属性
      • logo.object
        • 子属性
        • logostring

          默认logo

        • white_logostring

          白色logo

    • data.playerobject

      播放器

      • 子属性
      • player.object
        • 子属性
        • coverstring

          封面

        • enabled_bullet_secretint

          是否开启跑马灯

        • enabled_aliyun_privateint

          阿里云私密播放

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "code": 3,
  "message": "string",
  "data": {
    "webname": "string",
    "icp": "string",
    "user_protocol": "string",
    "aboutus": 3,
    "logo": {
      "": {
        "logo": "string",
        "white_logo": "string"
      }
    },
    "player": {
      "": {
        "cover": "string",
        "enabled_bullet_secret": 3,
        "enabled_aliyun_private": 3
      }
    }
  }
}

订单

创建课程订单

post/order/course
请求 Request

请求 BODY

  • course_idint

    课程id

  • promo_codestring

    优惠码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    订单

    • 子属性
    • data.idint

      id

    • data.user_idint

      用户id

    • data.chargeint

      总价

    • data.order_idstring

      订单编号

    • data.payment_methodstring

      支付方式

    • data.payment_textstring

      支付渠道文本

    • data.continue_payboolean

      是否可以继续支付

    • data.goodsarray

      商品

      • 数组成员object
      • goods.numint

        订购数量

      • goods.goods_textint

        商品名

      • goods.chargestring

        价格

      • goods.goods_typestring

        商品类型

    • data.status_textstring

      状态文本

    • data.created_atstring

      时间

Example 1

成功示例

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

创建套餐订单

post/order/role
请求 Request

请求 BODY

  • role_idint

    套餐id

  • promo_codestring

    优惠码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    订单

    • 子属性
    • data.idint

      id

    • data.user_idint

      用户id

    • data.chargeint

      总价

    • data.order_idstring

      订单编号

    • data.payment_methodstring

      支付方式

    • data.payment_textstring

      支付渠道文本

    • data.continue_payboolean

      是否可以继续支付

    • data.goodsarray

      商品

      • 数组成员object
      • goods.numint

        订购数量

      • goods.goods_textint

        商品名

      • goods.chargestring

        价格

      • goods.goods_typestring

        商品类型

    • data.status_textstring

      状态文本

    • data.created_atstring

      时间

Example 1

成功示例

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

创建视频订单

post/order/video
请求 Request

请求 BODY

  • video_idint

    视频id

  • promo_codestring

    优惠码

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    订单

    • 子属性
    • data.idint

      id

    • data.user_idint

      用户id

    • data.chargeint

      总价

    • data.order_idstring

      订单编号

    • data.payment_methodstring

      支付方式

    • data.payment_textstring

      支付渠道文本

    • data.continue_payboolean

      是否可以继续支付

    • data.goodsarray

      商品

      • 数组成员object
      • goods.numint

        订购数量

      • goods.goods_textint

        商品名

      • goods.chargestring

        价格

      • goods.goods_typestring

        商品类型

    • data.status_textstring

      状态文本

    • data.created_atstring

      时间

Example 1

成功示例

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

优惠码详情

get/promoCode/{code}
请求 Request

路由参数

  • codestring
    code
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    优惠码

    • 子属性
    • data.idint

      id

    • data.codestring

      优惠码

    • data.expired_atstring

      过期时间

    • data.invited_user_rewardint

      被邀请奖励

Example 1

成功示例

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

优惠码检测

get/promoCode/{code}/check
请求 Request

路由参数

  • codestring
    code
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

Example 1

成功示例

1
2
3
4
5
{
  "code": 3,
  "message": "string",
  "data": {}
}

支付

小程序支付

post/order/payment/wechat/mini
请求 Request

请求 BODY

  • openidstring

    openid

  • order_idstring

    订单编号

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.appIdstring

      appId

    • data.nonceStrstring

      nonceStr

    • data.packagestring

      package

    • data.paySignstring

      paySign

    • data.signTypestring

      signType

    • data.timeStampstring

      timeStamp

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
{
  "code": 3,
  "message": "string",
  "data": {
    "appId": "string",
    "nonceStr": "string",
    "package": "string",
    "paySign": "string",
    "signType": "string",
    "timeStamp": "string"
  }
}

支付网关

post/order/payments
请求 Request

请求 BODY

  • scenestring

    支付场景，h5,wechat

响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject
    • 子属性
    • data.signstring

      sign

    • data.namestring

      支付网关名

Example 1

成功示例

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

role

套餐列表

get/roles
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataarray
    • 数组成员object
    • data.idint

      套餐id

    • data.namestring

      套餐名

    • data.chargeint

      套餐价格

    • data.expire_daysint

      套餐天数

    • data.desc_rowsarray

      套餐描述

      • 数组成员object

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "code": 3,
  "message": "string",
  "data": [
    {
      "id": 3,
      "name": "string",
      "charge": 3,
      "expire_days": 3,
      "desc_rows": [
        {
          "": "string"
        }
      ]
    }
  ]
}

套餐详情

get/role/{id}
请求 Request

路由参数

  • idint
    视频id
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataobject

    会员套餐

    • 子属性
    • data.idint

      套餐id

    • data.namestring

      套餐名

    • data.chargeint

      套餐价格

    • data.expire_daysint

      套餐天数

    • data.desc_rowsarray

      套餐描述

      • 数组成员object

Example 1

成功示例

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

幻灯片

get/sliders
响应 Response
状态码 200

参数

  • codeint

    状态码

  • messagestring

    消息

  • dataarray
    • 数组成员object
    • data.thumbstring

      图片

    • data.urlstring

      url

    • data.sortint

      升序

Example 1

成功示例

1
2
3
4
5
6
7
8
9
10
11
{
  "code": 3,
  "message": "string",
  "data": [
    {
      "thumb": "string",
      "url": "string",
      "sort": 3
    }
  ]
}