拼课堂接口文档

拼课堂

更新历史

目录

1. 分类

1.1 创建分类

接口地址

/web/category/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
name	是	String	分类名称
logo	是	String	分类图标地址

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

1.2 获取分类

接口地址

/web/category/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X GET http://ip:port/web/category/all
Response
{"data":[{"create_time":"2019-03-08 10:27:56","id":1,"name":"test1","type":1},{"create_time":"2019-03-08 10:31:53","id":2,"name":"test2","type":1}],"success":true}

1.3 删除分类

接口地址

/web/category/del

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	String	分类ID

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"id":1} http://ip:port/web/category/del
Response
{"success":true}

1.4 获取分类 (公众号)

接口地址

/api/category/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X GET http://ip:port/api/category/all
Response
{"data":[{"create_time":"2019-03-08 10:27:56","id":1,"name":"test1","type":1},{"create_time":"2019-03-08 10:31:53","id":2,"name":"test2","type":1}],"success":true}

2. 轮播图

2.1 创建轮播图

接口地址

/web/banner/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
cover	是	String	封面图片
num	是	int	序号
type	否	int	内容类型，默认为1，1=拼团
content	是	int	内容ID
hide	是	int	是否显示，0显示，1不显示

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

2.2 获取轮播图列表

接口地址

/web/banner/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequesTBody

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X GET http://ip:port/web/category/all
Response

2.3 获取轮播图信息

接口地址

/web/banner/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
id	是	int	轮播图id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X GET http://ip:port/web/category/all
Response

2.4 删除轮播图

接口地址

/web/banner/del

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequestBody
id	是	String	轮播图ID

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"id":1} http://ip:port/web/banner/del
Response
{"success":true}

2.5 更新轮播图信息

接口地址

/web/banner/update

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequesTBody
id	是	int	轮播图ID
cover	否	String	封面图片
num	否	int	序号
content	否	int	内容ID
hide	否	int	是否显示，0显示，1不显示

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

2.6 获取轮播图列表 (公众号)

接口地址

/api/banner/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
RequesTBody

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X GET http://ip:port/web/category/all
Response

3. 课程

3.1 新建课程

接口地址

/web/course/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
title	是	课程名称
cover	是	String	封面图片地址
category	是	int	分类id
copyright	是	int	版权商id

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

3.2 编辑课程

接口地址

/web/course/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
title	否	课程名称
cover	否	String	封面图片地址
category	否	int	分类id
copyright	否	int	版权商id

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

3.3 查询课程

接口地址

/web/course/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
id	是	int	课程id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

3.4 删除课程

接口地址

/web/course/del

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	String	课程id

HTTP 响应状态

200

接口示例

Request
curl -X POST -H "Content-Type:application/json" -d {"id":1} http://ip:port/web/course/del
Response
{"success":true}

3.5 查询课程列表

接口地址

/web/course/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
title	否	String	课程名称
category	否	int	分类id
copyright	否	int	版权商id
fromDate	否	String	开始时间，格式为20190320
toDate	否	String	结束时间，格式为20190320

HTTP 响应状态

200

DataItem

3.6 课程统计

接口地址

/web/course/sum

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response

4. 章节

4.1 新建章节

接口地址

/web/chapter/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
title	是	课程名称
cover	是	String	封面图片地址
courseid	是	int	所属课程id
video	是	String	视频文件地址

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.2 获取章节

接口地址

/web/chapter/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
id	是	章节id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.3 更新章节

接口地址

/web/chapter/update

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	int	章节id
title	否	String	标题
cover	否	String	封面图片

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.4 删除章节

接口地址

/web/chapter/del

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	int	章节id

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.5 获取指定课程的所有章节

接口地址

/web/chapter/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
courseid	是	章节id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.6 章节统计

接口地址

/web/chapter/sum

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.7 章节排序

接口地址

/web/chapter/sort

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
data	是	JsonArray	详细信息请见 DataItem

DataItem

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

4.8 获取指定课程的所有章节 (公众号)

接口地址

/api/chapter/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
courseid	是	章节id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5. 拼团

5.1 新建拼团

接口地址

/web/group/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
courseid	是	int	关联的课程id
cover	是	String	封面图片地址
poster	是	String	海报图片地址
price	是	float	商品原价
discount	是	float	拼团价格
tips	是	String	购买须知
abstracts	是	String	摘要
card	是	String	邀请卡图片地址
recommend	是	int	是否推荐,0不推荐，1推荐
title	是	String	标题
category	是	int	分类ID
description	是	String	课程详情图片地址
course_cover	是	String	课程封面图片地址

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.2 查询拼团

接口地址

/web/group/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
id	是	int	拼团id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.3 更新拼团信息

接口地址

/web/group/update

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	int	拼团id
courseid	否	int	关联的课程id
cover	否	String	封面图片地址
poster	否	String	海报图片地址
price	否	float	商品原价
discount	否	float	拼团价格
tips	否	String	购买须知
abstracts	否	String	摘要
card	否	String	邀请卡图片地址
recommend	否	int	是否推荐,0不推荐，1推荐
title	否	String	标题
category	否	int	分类ID
description	否	String	课程详情图片地址
course_cover	否	String	课程封面图片地址

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.4 删除拼团

接口地址

/web/group/del

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
id	是	int	拼团id

HTTP 响应状态

200

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.5 查询拼团列表

接口地址

/web/group/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
title	否	String	按照标题模糊查询

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.6 拼团数量

接口地址

/web/group/sum

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.7 查询推荐拼团列表 (公众号)

接口地址

/api/group/recommend

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.8 查询广场拼团列表 (公众号)

接口地址

/api/group/all

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
category	否	int	按照分类查询

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

5.9 拼团详情 (公众号)

接口地址

/api/group/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
id	是	int	拼团id

HTTP 响应状态

200

DataItem

ChapterItem

UserItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

6. 参团

6.1 发起/参加拼团 (公众号)

接口地址

/api/groupbuy/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
grouid	是	int	拼团id
userid	是	int	用户id
username	是	String	用户名
buyid	否	String	参团id，角色为发起人，可不传
role	是	int	参团角色，0团长，1团员
avatar	是	String	头像

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

6.2 获取参团信息 (公众号)

接口地址

/api/groupbuy/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
buyid	否	String	参团id

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

6.3 获取参团列表

接口地址

/web/groupbuy/query

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
groupid	是	String	拼团id
status	否	String	参团状态
username	否	String	按照团长名称模糊搜索

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

6.4 参团统计

接口地址

/web/groupbuy/sum

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams

无

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

6.5 我的拼团 (公众号)

接口地址

/api/groupbuy/mylist

HTTP Content-Type

application/json

HTTP 请求方式

GET

请求参数

参数	必选	类型	说明
QueryParams
userid	是	int	用户ID

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

7. 观看记录

7.1 上报观看记录 (公众号)

接口地址

/api/learnt/add

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
userid	是	int	用户id
courseid	是	int	课程id
chapter	是	int	章节id
num	是	int	章节序号

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/web/category/add
Response
{"data":"ok","success":true}

8. 用户

8.1 注册

接口地址

/web/user/reg

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	string	用户名
password	是	int	密码

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/api/user/reg
Response
{"data":"ok","success":true}

8.2 登录

接口地址

/web/user/login

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
username	是	string	用户名
password	是	int	密码

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/api/user/login
Response
{"data":"ok","success":true}

8.3 用户详情

接口地址

/web/user/info

HTTP Content-Type

application/json

HTTP 请求方式

POST

请求参数

参数	必选	类型	说明
RequestBody
userid	是	int	用户userid

HTTP 响应状态

200

DataItem

接口示例

Request
curl -X POST -d {"name":"xxxxx"} http://ip:port/api/user/info
Response
{"data":"ok","success":true}