多样青春搭+（活动版）

微信工具类接口

GET index /api/wechat_util/index

index

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 微信小程序生成二维码 /api/wechat_util/qrcode

微信小程序生成二维码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
path	string	否	通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序生成url-scheme /api/wechat_util/scheme

微信小程序生成url-scheme

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
path	string	否	通过 scheme 码进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query。path 为空时会跳转小程序主页。
query	string	否	通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符
env_version	string	否	默认值release。要打开的小程序版本。正式版为release，体验版为trial，开发版为develop，仅在微信外打开时生效。
expire_time	number	否	到期失效的 scheme 码的失效时间，为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为30天。is_expire 为 true 且 expire_type 为 0 时必填
expire_type	number	否	默认值0，到期失效的 scheme 码失效类型，失效时间：0，失效间隔天数：1
expire_interval	number	否	到期失效的 scheme 码的失效间隔天数。生成的到期失效 scheme 码在该间隔时间到达前有效。最长间隔天数为30天。is_expire 为 true 且 expire_type 为 1 时必填

正文

无

参数

追加

path

query

env_version

expire_time

expire_type

expire_interval

响应输出

返回参数

名称	类型	描述
code	integer
openlink	string

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序生成url-link /api/wechat_util/link

微信小程序生成url-link

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
path	string	否	通过 URL Link 进入的小程序页面路径，必须是已经发布的小程序存在的页面，不可携带 query 。path 为空时会跳转小程序主页
query	string	否	通过 scheme 码进入小程序时的 query，最大1024个字符，只支持数字，大小写英文以及部分特殊字符
env_version	string	否	默认值release。要打开的小程序版本。正式版为release，体验版为trial，开发版为develop，仅在微信外打开时生效。
expire_time	number	否	到期失效的 scheme 码的失效时间，为 Unix 时间戳。生成的到期失效 scheme 码在该时间前有效。最长有效期为30天。is_expire 为 true 且 expire_type 为 0 时必填
expire_type	number	否	默认值0，到期失效的 scheme 码失效类型，失效时间：0，失效间隔天数：1
cloud_env	string	否	云开发静态网站自定义 H5 配置参数: 云开发环境
cloud_domain	string	否	云开发静态网站自定义 H5 配置参数: 静态网站自定义域名，不填则使用默认域名
cloud_path	string	否	云开发静态网站自定义 H5 配置参数: 云开发静态网站 H5 页面路径，不可携带 query
cloud_query	string	否	云开发静态网站自定义 H5 配置参数: 云开发静态网站 H5 页面 query 参数，最大 1024 个字符，只支持数字，大小写英文以及部分特殊字符
cloud_resource_appid	string	否	云开发静态网站自定义 H5 配置参数: 第三方批量代云开发时必填，表示创建该 env 的 appid （小程序/第三方平台）

正文

无

参数

追加

path

query

env_version

expire_time

expire_type

cloud_env

cloud_domain

cloud_path

cloud_query

cloud_resource_appid

响应输出

返回参数

名称	类型	描述
code	integer
url_link	string

无

POST 获取不限制的小程序码（太阳码） /api/wechat_util/codeunlimit

获取不限制的小程序码（太阳码）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
page	string	否	默认是主页，页面 page，例如 pages/index/index，根路径前不要填加 /，不能携带参数（参数请放在scene字段里），如果不填写这个字段，默认跳主页面。scancode_time为系统保留参数，不允许配置
scene	string	否	最大32个可见字符，只支持数字，大小写英文以及部分特殊字符：!#$&'(
env_version	string	否	默认值release。要打开的小程序版本。正式版为release，体验版为trial，开发版为develop，仅在微信外打开时生效。
check_path	bool	否	默认是true，检查page 是否存在，为 true 时 page 必须是已经发布的小程序存在的页面（否则报错）；为 false 时允许小程序未发布或者 page 不存在，但page 有数量上限（60000个）请勿滥用。
width	number	否	默认430，二维码的宽度，单位 px，最小 280px，最大 1280px
auto_color	bool	否	自动配置线条颜色，如果颜色依然是黑色，则说明不建议配置主色调，默认 false
line_color	json	否	默认是{’r’:0,’g’:0,’b’:0} 。auto_color 为 false 时生效，使用 rgb 设置颜色例如 {’r’:’xxx’,’g’:’xxx’,’b’:’xxx’} 十进制表示
is_hyaline	bool	否	默认是false，是否需要透明底色，为 true 时，生成透明底色的小程序

正文

无

参数

追加

page

scene

env_version

check_path

width

auto_color

line_color

is_hyaline

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序生成用户画像 /api/wechat_util/getWeanalysisAppidUserportrait

微信小程序生成用户画像

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 开始日期与结束日期相差的天数限定为0/6/29，分别表示查询最近1/7/30天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序访问页面 /api/wechat_util/getWeanalysisAppidVisitPage

微信小程访问页面

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序月留存 /api/wechat_util/getWeanalysisAppidMonthlyRetaininfo

微信小程序月留存

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期，为自然月第一天
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，为自然月最后一天，限定查询一个月数据

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序周留存 /api/wechat_util/getWeanalysisAppidWeeklyRetaininfo

微信小程序周留存

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期，为周一日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，为周日日期，限定查询一周数据

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序日留存 /api/wechat_util/getWeanalysisAppidDailyRetaininfo

微信小程序日留存

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序访问分布 /api/wechat_util/getWeanalysisAppidVisitdistribution

微信小程序访问分布

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序月趋势 /api/wechat_util/getWeanalysisAppidMonthlyVisittrend

微信小程序月趋势

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期，为自然月第一天
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，为自然月最后一天，限定查询一个月数据

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序周趋势 /api/wechat_util/getWeanalysisAppidWeeklyVisittrend

微信小程序周趋势

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期，为周一日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，为周日日期，限定查询一周数据

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序访问分析 /api/wechat_util/getWeanalysisAppidDailyVisittrend

微信小程序访问分析

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序数据分析 /api/wechat_util/getWeanalysisAppidDailySummarytrend

微信小程序数据分析

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 查询微信报错rid信息 /api/wechat_util/getRidInfo

本接口用于查询调用公众号/小程序/第三方平台等接口报错返回的rid详情信息，辅助开发者高效定位问题

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
rid	string	是	调用接口报错返回的rid

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

户外运动接口

POST 户外运动招募申请表单 /api/school.spor_apply/add

户外运动招募申请表单

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	联系人
mobile	string	是	联系电话
enterprise_name	string	是	企业名称
enterprise_addr	string	是	企业地址
outdoor_sport	string	是	经营/热爱的户外运动

正文

无

参数

追加

name

mobile

enterprise_name

enterprise_addr

outdoor_sport

响应输出

返回参数

无

{
     *
     *}

员工端公共接口

GET 加载初始化 /api/school.worker.common/init

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 员工端上传文件 /api/school.worker.common/upload

员工端上传文件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
file	File	是	文件流
category	string	是	分类标识：category1=非机密类1,category2=非机密类2,cert=证件机密类,code=二维码类,user=用户普通上传

正文

无

参数

追加

file

员工端：课时订单管理接口

POST 员工代下单：订单确认/订单计算接口 /api/school/worker/hour_order/confirm

订单确认/订单计算接口【有过期时间】

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	int	是	课程订单id
classes_lib_spec_id	int	否	课时规格id
order_no	string	否	缓存key
is_compute	int	否	是否重新计算并更新缓存默认传1

正文

无

参数

追加

classes_order_id

classes_lib_spec_id

order_no

is_compute

响应输出

返回参数

无

{
     *
     *}

POST 员工代下单：订单下单接口 /api/school/worker/hour_order/create

订单下单接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	缓存key

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：预约课时单取消接口 /api/school/worker/hour_order/cancel

预约课时单取消接口（已完成的单无法取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：预约课时单审核接口 /api/school/worker/hour_order/examine

预约课时单审核接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号
auth_status	int	是	审核状态:1=审核通过,2=审核失败
reason	string	否	审核失败理由

正文

无

参数

追加

order_no

auth_status

reason

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：预约课时单核销完成接口 /api/school/worker/hour_order/verification

预约课时单核销完成接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：预约课修改课时接口 /api/school/worker/hour_order/update_spec

预约课修改课时接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号
classes_lib_spec_id	int	是	要更换的课时id

正文

无

参数

追加

order_no

classes_lib_spec_id

响应输出

返回参数

无

{
     *
     *}

GET 课时订单详情 /api/school/worker/hour_order/detail

课时订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的课时订单列表接口 /api/school/worker/hour_order/order_list

我的课时订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	订单状态:-3=已取消,-1=已报名待审核,0=已预约,3=已完成
classes_order_id	string	否	课程订单id
classes_lib_id	int	否	课程id
shop_id	int	否	机构shopid
start_time	string	否	按开始时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）
createtime	string	否	按创建时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）
time	string	否	按开始和结束时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）

正文

无

参数

追加

keywords

page

limit

status

classes_order_id

classes_lib_id

shop_id

start_time

createtime

time

响应输出

返回参数

无

{
     *
     *}

GET 课时订单数量接口 /api/school/worker/hour_order/order_count

课时订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	int	是	课程订单id
classes_lib_id	int	否	课程id

正文

无

参数

追加

classes_order_id

classes_lib_id

响应输出

返回参数

无

{
     *
     *}

（已废弃）员工端：课程活动订单管理接口

GET 订单详情 /api/school.worker.activity.order/detail

订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的订单列表接口 /api/school.worker.activity.order/order_list

我的订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：-3=已取消,0=待支付,2=已报名待审核,3=已预约,4=售后中,6=已退款,9=已完成
auth_status	string	否	审核状态:0=待审核,1=审核通过,2=审核失败
classes_activity_id	int	否	课程活动id

正文

无

参数

追加

keywords

page

limit

status

auth_status

classes_activity_id

响应输出

返回参数

无

{
     *
     *}

GET 我的订单数量接口 /api/school.worker.activity.order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_activity_id	int	否	课程活动id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：活动订单取消接口 /api/school.worker.activity.order/cancel

活动订单取消接口（已支付单无法取消，要走售后）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：预约报名审核接口 /api/school.worker.activity.order/examine

预约报名审核接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	活动订单号
auth_status	int	是	审核状态:1=审核通过,2=审核失败
reason	string	否	审核失败理由

正文

无

参数

追加

order_no

auth_status

reason

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：活动核销完成接口 /api/school.worker.activity.order/verification

活动核销完成接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	活动订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

员工端：课程订单管理接口

GET 订单详情 /api/school/worker/order/detail

订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的订单列表接口 /api/school/worker/order/order_list

我的订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：-3=已取消,0=待支付,3=使用中,6=已退款,9=已完成
classes_lib_id	int	否	课程id

正文

无

参数

追加

keywords

page

limit

status

classes_lib_id

响应输出

返回参数

无

{
     *
     *}

POST 员工代操作：课程订单未支付取消接口 /api/school/worker/order/cancel

课程订单未支付取消接口（已支付单无法取消，要走售后）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的订单数量接口 /api/school/worker/order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_lib_id	int	否	课程id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

员工端：课程订单售后接口

GET 用户售后订单详情 /api/school.worker.service_order/detail

用户售后订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	售后订单id或售后订号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 用户售后订单列表接口 /api/school.worker.service_order/order_list

用户售后订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：售后状态:1=待处理,4=处理中,7=已结单,-3=已取消
service_stauts	string	否	售后处理状态:1=待机构处理,4=待用户确认,7=售后通过结单中,10=售后结单完成,-3=售后驳回结单
sales_type	string	否	结单类型:-3=未结单,1=机构驳回,4=用户驳回,7=平台驳回,10=成功退款
classes_lib_id	int	否	课程id
classes_order_id	int	否	课程订单id
classes_order_detail_id	int	否	订单课程id

正文

无

参数

追加

keywords

page

limit

status

service_stauts

sales_type

classes_lib_id

classes_order_id

classes_order_detail_id

响应输出

返回参数

无

{
     *
     *}

GET 用户售后订单数量接口 /api/school.worker.service_order/order_count

返回售后订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_lib_id	int	否	课程id
classes_order_id	int	否	课程订单id

正文

无

参数

追加

classes_lib_id

classes_order_id

响应输出

返回参数

无

{
     *
     *}

GET 售后订单记录列表接口 /api/school.worker.service_order/order_log_list

售后订单记录列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：售后状态:1=待处理,4=处理中,7=已结单,-3=已取消
service_stauts	string	否	售后处理状态:1=待机构处理,4=待用户确认,7=售后通过结单中,10=售后结单完成,-3=售后驳回结单
sales_type	string	否	结单类型:-3=未结单,1=机构驳回,4=用户驳回,7=平台驳回,10=成功退款
classes_service_order_id	int	否	售后订单id

正文

无

参数

追加

keywords

page

limit

status

service_stauts

sales_type

classes_service_order_id

响应输出

返回参数

无

{
     *
     *}

POST 机构处理售后接口 /api/school.worker.service_order/shop_confirmation

机构处理售后接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	售后订单id或售后订号
status	string	是	yes=同意，no=驳回
price	string	否	同意的售后金额
reject_reason	string	否	驳回原因
reject_images	string	否	（非必填）驳回图片说明：多图逗号拼接

正文

无

参数

追加

order_no

status

price

reject_reason

reject_images

响应输出

返回参数

无

{
     *
     *}

POST/GET POST机构帮用户申请售后接口【get 传入classes_order_id 查询计算退款额度】 /api/school.worker.service_order/create

机构帮用户申请售后接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	string	是	需要售后的课程订单id
reason	string	是	申请理由
price	string	是	同意的退款金额

正文

无

参数

追加

classes_order_id

reason

price

响应输出

返回参数

无

{
     *
     *}

用户端：评价接口

GET 评价列表接口 /api/school.evaluate/evaluate_list

我的评价列表接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
my	string	否	是否查我的评价（需登录）
classes_lib_id	string	否	课程id
classes_order_id	string	否	课程订单id
shop_id	string	否	机构店铺id
teacher_id	string	否	老师id
time	string	否	复合时间查询:today今天,week本周,month本月,year本年,yesterday昨天,last year上一年,last week上周，last month上個月，lately7最近7天， lately30最近30天，按开始时间区间查传值格式：Y/m/d H:M:S-Y/m/d H:M:S

正文

无

参数

追加

keywords

page

limit

classes_lib_id

classes_order_id

shop_id

teacher_id

time

响应输出

返回参数

无

{
     *
     *}

GET 评价详情 /api/school.evaluate/detail

评价详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	评价id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 发起课程反馈 /api/school.evaluate/evaluate

发起课程反馈

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	否	课程订单id
message_text	string	是	评价内容
classes_star	float	是	课程评分：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5
teacher_star	float	否	讲师评分：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5
shop_star	float	否	教师环境：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5

正文

无

参数

追加

order_no

message_text

classes_star

teacher_star

shop_star

响应输出

返回参数

无

{
     *
     *}

POST 课程反馈更新 /api/school.evaluate/evaluate_update

课程反馈更新

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	否	课程订单id
message_text	string	是	评价内容
classes_star	float	是	课程评分：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5
teacher_star	float	否	讲师评分：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5
shop_star	float	否	教师环境：只能是数字0.5，1，1.5，2，2.5，3，3.5，4，4.5，5

正文

无

参数

追加

order_no

message_text

classes_star

teacher_star

shop_star

响应输出

返回参数

无

{
     *
     *}

个人发票抬头库管理

GET 抬头列表接口 /api/school.header/header_list

抬头列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数

正文

无

参数

追加

keywords

page

limit

响应输出

返回参数

无

{
     *
     *}

GET 抬头详情 /api/school.header/detail

抬头详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	抬头id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 删除抬头 /api/school.header/del

删除抬头

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	要删除的ids

正文

无

参数

追加

响应输出

返回参数

无

无

POST 添加抬头 /api/school.header/add

添加抬头

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
head_type	string	是	抬头类型:personal=个人或事业单位,corporate=企业
invoice_type	string	是	发票类型:ordinary=普通发票,special=专用发票
invoice_header	string	是	发票抬头
tax_id	string	是	税号
bank_deposit	string	是	开户银行
bank_number	string	是	银行账号
enterprise_address	string	是	企业地址
enterprise_phone	string	是	企业电话
invoice_reservation_phone	string	是	发票预留电话
invoice_reservation_email	string	是	发票预留邮箱
is_default	string	是	是否默认:0=否,1=是

正文

无

参数

追加

head_type

invoice_type

invoice_header

tax_id

bank_deposit

bank_number

enterprise_address

enterprise_phone

invoice_reservation_phone

invoice_reservation_email

is_default

响应输出

返回参数

无

{
     *
     *}

POST 编辑成员 /api/school.header/edit/ids/{ids}

编辑成员

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	需要编辑的id
head_type	string	是	抬头类型:personal=个人或事业单位,corporate=企业
invoice_type	string	是	发票类型:ordinary=普通发票,special=专用发票
invoice_header	string	是	发票抬头
tax_id	string	是	税号
bank_deposit	string	是	开户银行
bank_number	string	是	银行账号
enterprise_address	string	是	企业地址
enterprise_phone	string	是	企业电话
invoice_reservation_phone	string	是	发票预留电话
invoice_reservation_email	string	是	发票预留邮箱
is_default	string	是	是否默认:0=否,1=是

正文

无

参数

追加

ids

head_type

invoice_type

invoice_header

tax_id

bank_deposit

bank_number

enterprise_address

enterprise_phone

invoice_reservation_phone

invoice_reservation_email

is_default

响应输出

返回参数

无

{
     *
     *}

POST 订单申请开票（单开|合开） /api/school.header/apply

订单申请开票

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_nos	string	是	需要开票的订单号：多开传多个逗号隔开字符串
head_type	string	是	抬头类型:personal=个人或事业单位,corporate=企业
invoice_type	string	是	发票类型:ordinary=普通发票,special=专用发票
invoice_header	string	是	发票抬头
tax_id	string	是	税号
bank_deposit	string	是	开户银行
bank_number	string	是	银行账号
enterprise_address	string	是	企业地址
enterprise_phone	string	是	企业电话
invoice_reservation_phone	string	是	发票预留电话
invoice_reservation_email	string	是	发票预留邮箱

正文

无

参数

追加

order_nos

head_type

invoice_type

invoice_header

tax_id

bank_deposit

bank_number

enterprise_address

enterprise_phone

invoice_reservation_phone

invoice_reservation_email

响应输出

返回参数

无

{
     *
     *}

GET 申请列表接口 /api/school.header/apply_list

申请列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	申请状态:1=申请中,2=已开票,-3=作废

正文

无

参数

追加

keywords

page

limit

status

响应输出

返回参数

无

{
     *
     *}

活动接口（已废弃）

GET 活动demo数据详情 /api/school.activity/demo_detail

活动demo数据详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动demo数据id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 活动demo数据列表（取决于搜索条件） /api/school.activity/demo_list

活动demo数据列表（取决于搜索条件）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态:1=报名中,2=已结束

正文

无

参数

追加

keywords

page

limit

status

响应输出

返回参数

无

{
     *
     *}

GET 通用活动大索索列表 /api/school/activity/activity_list

通用活动大索索列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
start_time	int	否	开始时间10位秒级时间戳
end_time	int	否	结束时间10位秒级时间戳
sign_start_time	int	否	报名开始时间10位秒级时间戳
sign_end_time	int	否	报名结束时间10位秒级时间戳
has_shop	int	否	是否查机构
is_expire	int	否	是否查过期：1只查过期,2只查不过期,0全查
is_sign_expire	int	否	是否查报名过期：1只查过期,2只查不过期,0全查
shop_id	int	否	机构店铺id
keyword	string	否	关键字搜索
address_type	string	否	地址类型:1=按机构,2=独立位置
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
status	string	否	不传则默认查上架的状态: 1=上架,2=下架,3=平台下架
recommend	string	否	平台推荐:0=否,1=是
hot	string	否	平台热门:0=否,1=是
new	string	否	平台最新:0=否,1=是
selfhot	string	否	机构热门:0=否,1=是
feel	string	否	是否免费:0=否,1=是
collect	int	否	是否专查我的收藏(需登录
order	string	否	normal=综合排序推薦優先,distance=距离优先,hot=熱門优先,new=平台最新优先,selfhot=机构热门优先,sale=銷量优先,views=浏览量优先,collect=收藏量优先
nearby	string	否	限制最大搜索距离（米）
latitude	string	否	latitude
longitude	string	否	longitude

正文

无

参数

追加

keywords

page

limit

start_time

end_time

sign_start_time

sign_end_time

has_shop

is_expire

is_sign_expire

shop_id

keyword

address_type

province

city

district

status

recommend

hot

new

selfhot

feel

collect

order

nearby

latitude

longitude

响应输出

返回参数

无

{
     *
     *}

GET 课程活动规格 /api/school/activity/spec

课程活动规格

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动id
user_id	int	是	需要查询是否下单的用户id

正文

无

参数

追加

user_id

响应输出

返回参数

无

{ spec 活动规格 }

GET 活动详情接口 /api/school/activity/detail

活动详情接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动id

正文

无

参数

追加

响应输出

返回参数

无

{

     *
     *}

POST 设置活动收藏和取消收藏 /api/school/activity/collect

设置活动收藏和取消收藏

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动id
is_collect	int	是	收藏操作：0取消收藏，1收藏

正文

无

参数

追加

is_collect

响应输出

返回参数

无

{
     *
     *}

用户端：课时预约订单接口

POST 订单确认/订单计算接口 /api/school/hour_order/confirm

订单确认/订单计算接口【有过期时间】

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	int	是	课程订单id
classes_lib_spec_id	int	否	课时规格id
order_no	string	否	缓存key
is_compute	int	否	是否重新计算并更新缓存默认传1

正文

无

参数

追加

classes_order_id

classes_lib_spec_id

order_no

is_compute

响应输出

返回参数

无

{
     *
     *}

POST 订单下单接口 /api/school/hour_order/create

订单下单接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	缓存key

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 预约课时单取消接口 /api/school/hour_order/cancel

预约课时单取消接口（已完成的单无法取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 课时订单详情 /api/school/hour_order/detail

课时订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的课时订单列表接口 /api/school/hour_order/order_list

我的课时订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	订单状态:-3=已取消,-1=已报名待审核,0=已预约,3=已完成
classes_order_id	int	是	课程订单id
classes_lib_id	int	否	课程id
time	string	否	按开始和结束时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）
start_time	string	否	按开始时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）
createtime	string	否	按创建时间区间查（传值格式：Y/m/d H:M:S-Y/m/d H:M:S）

正文

无

参数

追加

keywords

page

limit

status

classes_order_id

classes_lib_id

time

start_time

createtime

响应输出

返回参数

无

{
     *
     *}

GET 我的课时订单数量接口 /api/school/hour_order/order_count

返回课时订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	int	是	课程订单id
classes_lib_id	int	否	课程id

正文

无

参数

追加

classes_order_id

classes_lib_id

响应输出

返回参数

无

{
     *
     *}

GET 通过时间点得到当前的月份数据 /api/school.hour_order/get_month_by_time

通过时间点得到当前的月份数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	是	选择的时间点时间戳
status	string	否	订单状态:-3=已取消,-1=已报名待审核,0=已预约,3=已完成

正文

无

参数

追加

time

status

响应输出

返回参数

无

无

用户端：站内信接口

GET 站内信详情-确认已读 /api/school/message/detail

站内信详情-确认已读

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	消息id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的消息列表接口 /api/school/message/message_list

我的消息列表接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	消息总类型:system=系统消息,classes=课程消息,order=订单消息
mini_type	string	否	小消息类型:order_notice=课程订单通知,classes_auth=课程报名审核,classes_apply=课程上新审核,shop_apply=机构审核,classes_order_notice=课时预约,user_auth=机构授权用户信息,aftercare=售后服务,other=其他
type	string	否	已读状态:1=未读,2=已读
time	string	否	复合时间查询:today今天,week本周,month本月,year本年,yesterday昨天,last year上一年,last week上周，last month上個月，lately7最近7天， lately30最近30天，按开始时间区间查传值格式：Y/m/d H:M:S-Y/m/d H:M:S

正文

无

参数

追加

keywords

page

limit

status

mini_type

type

time

响应输出

返回参数

无

{
     *
     *}

GET 我的消息数量接口 /api/school/message/message_count

我的消息数量接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 设置一键已读 /api/school.message/batch

设置一键已读

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	否	默认* 多值逗号拼接
event	string	否	要删的事件
status	string	否	消息总类型:system=系统消息,classes=课程消息,order=订单消息
mini_type	string	否	小消息类型:order_notice=课程订单通知,classes_auth=课程报名审核,classes_apply=课程上新审核,shop_apply=机构审核,classes_order_notice=课时预约,user_auth=机构授权用户信息,aftercare=售后服务,other=其他

正文

无

参数

追加

event

status

mini_type

响应输出

返回参数

无

{
     *
     *}

员工端：活动订单管理接口

GET 用户活动订单详情 /api/school.newworker.activity.order/detail

用户活动订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 用户活动订单列表接口 /api/school.newworker.activity.order/order_list

用户活动订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	订单状态:-3=已取消,0=待支付,2=已报名,3=核销中,4=售后中,5=退款结算中,6=已退款,9=已完成
server_status	string	否	售后订单状态:0=正常,3=售后中,6=售后完成
auth_status	string	否	售后结果状态:0=待审核,1=同意退款,2=拒绝退款
invoice_status	string	否	发票申请状态:0=未申请,1=申请中,2=已开票
have_invoice	int	否	是否查可开票:1是
activity_id	int	否	活动id

正文

无

参数

追加

keywords

page

limit

status

server_status

auth_status

invoice_status

have_invoice

activity_id

响应输出

返回参数

无

{
     *
     *}

GET 用户订单数量接口 /api/school.newworker.activity.order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
activity_id	int	否	活动id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 员工操作：订单核销接口 /api/school.newworker.activity.order/verification

订单核销接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	string	是	核销码

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 处理售后接口 /api/school.newworker.activity.order/shop_confirmation

处理售后接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	售后订单id或售后订号
status	string	是	yes=同意，no=驳回
price	string	否	同意的售后金额
reject_reason	string	否	驳回原因

正文

无

参数

追加

order_no

status

price

reject_reason

响应输出

返回参数

无

{
     *
     *}

活动支付接口（已废弃）

POST 活动第三方支付 /api/school.activity.pay/payment

活动第三方支付（微信等支付）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单id或订单号
type	string	是	服务商:alipay=支付宝,wechat=微信
platform	string	是	平台:web=PC网页支付,wap=H5手机网页支付,app=APP支付,scan=扫码支付,mp=微信公众号支付,miniapp=微信小程序支付
openid	string	否	用户openid(非必填

正文

无

参数

追加

order_no

type

platform

openid

响应输出

返回参数

无

{
     *
     *}

GET 第三方支付支付成功回调 /api/school.activity.pay/notifyx

第三方支付成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 支付返回，网页支付版本（小程序忽略） /api/school.activity.pay/returnx

支付返回，网页支付版本（小程序忽略）

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 支付返回 /api/school.activity.pay/notifyRefund

支付返回

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 退款成功回调 /api/school.activity.pay/notifyr

退款成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

用户端：活动订单接口（已废弃）

GET 订单详情 /api/school.activity.order/detail

订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的订单列表接口 /api/school.activity.order/order_list

我的订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	订单状态:-3=已取消,0=待支付,2=已报名待审核,3=已预约,4=售后中,6=已退款,9=已完成
auth_status	string	否	审核状态:0=待审核,1=审核通过,2=审核失败
classes_activity_id	int	否	课程活动id

正文

无

参数

追加

keywords

page

limit

status

auth_status

classes_activity_id

响应输出

返回参数

无

{
     *
     *}

GET 我的订单数量接口 /api/school.activity.order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_activity_id	int	否	课程活动id（非必填）

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 订单确认/订单计算接口 /api/school.activity.order/confirm

订单确认/订单计算接口【有过期时间】

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_activity_id	int	是	活动id
order_no	string	否	缓存key
classes_activity_item_id	int	是	活动规定id
is_compute	int	否	是否重新计算并更新缓存默认传1

正文

无

参数

追加

classes_activity_id

order_no

classes_activity_item_id

is_compute

响应输出

返回参数

无

{
     *
     *}

POST 订单下单接口 /api/school.activity.order/create

订单下单接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	缓存key

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 活动单取消接口 /api/school.activity.order/cancel

活动单取消接口（已完成的单无法取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

机构接口

GET 机构详情 /api/school/shop/detail

机构详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	机构id

正文

无

参数

追加

响应输出

返回参数

无

{

     *
     *}

POST 机构申请（废弃） /api/school/shop/shopapply

机构申请（废弃）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	机构名称
tel	string	否	服务电话(非必填
desc	string	否	申请备注(非必填
front_idcard_image	string	是	法人身份证正面
reverse_idcard_image	string	是	法人身份证反面
images	string	是	机构环境照片（多个逗号拼接）
yyzzdm	string	是	社会统一信用代码
yyzz_images	string	是	营业执照照片（多个逗号拼接）
address	string	是	店铺地址
address_detail	string	是	店铺详细地址
longitude	string	是	经度
latitude	string	是	纬度
province	int	是	省编号
city	int	是	市编号
district	int	是	县区编号
establish_time	int	是	成立时间10位秒级时间戳
people	int	是	员工人数
legal_entity	string	是	法人姓名
gender	int	是	法人性别:0=女,1=男
nation	string	是	法人民族
out_look	string	是	法人政治面貌
birthtime	int	是	法人出生日期10位秒级时间戳
native_place	string	是	法人籍贯
card_number	string	是	法人身份证号码
diploma	string	是	法人学历
post	string	是	法人职务
social_position	string	是	法人社会职务

正文

无

参数

追加

name

tel

desc

front_idcard_image

reverse_idcard_image

images

yyzzdm

yyzz_images

address

address_detail

longitude

latitude

province

city

district

establish_time

people

legal_entity

gender

nation

out_look

birthtime

native_place

card_number

diploma

post

social_position

响应输出

返回参数

无

{
     *
     *}

POST 个人申请（废弃） /api/school/shop/userapply

个人申请（废弃）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	姓名
tel	string	否	服务电话(非必填
desc	string	否	申请备注(非必填
front_idcard_image	string	是	身份证正面
reverse_idcard_image	string	是	身份证反面
address	string	是	地址
address_detail	string	是	详细地址
longitude	string	是	经度
latitude	string	是	纬度
province	int	是	省编号
city	int	是	市编号
district	int	是	县区编号
gender	int	是	个人性别:0=女,1=男
nation	string	是	个人民族
out_look	string	是	个人政治面貌
birthtime	int	是	个人出生日期10位秒级时间戳
native_place	string	是	个人籍贯
card_number	string	是	个人身份证号码
diploma	string	是	个人学历
post	string	是	个人职务
social_position	string	是	个人社会职务

正文

无

参数

追加

name

tel

desc

front_idcard_image

reverse_idcard_image

address

address_detail

longitude

latitude

province

city

district

gender

nation

out_look

birthtime

native_place

card_number

diploma

post

social_position

响应输出

返回参数

无

{
     *
     *}

GET 机构申请状态 /api/school/shop/auth_info

机构申请状态

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 通用机构大索索列表 /api/school.shop/shop_list

通用机构大索索列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
user_id	int	否	主讲师用户id
shop_id	int	否	机构店铺id
teacher_id	int	否	老师id
keyword	string	否	关键字搜索
type	string	否	类型:1=个人,2=机构
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
status	string	否	不传则默认查上架的审核状态:0=待审核,1=审核通过,2=审核失败
order	string	否	normal=综合排序優先,distance=距离优先
nearby	string	否	限制最大搜索距离（米）
latitude	string	否	latitude
longitude	string	否	longitude

正文

无

参数

追加

keywords

page

limit

user_id

shop_id

teacher_id

keyword

type

province

city

district

status

order

nearby

latitude

longitude

响应输出

返回参数

无

{
     *
     *}

POST 编辑认证信息 /api/school/shop/edit

编辑认证信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	机构名称
logo	string	是	logo单图
image	string	是	封面单图
content	string	是	店铺详情
tel	string	是	服务电话(非必填
desc	string	否	申请备注(非必填
front_idcard_image	string	是	法人身份证正面
reverse_idcard_image	string	是	法人身份证反面
images	string	是	环境照片（多个逗号拼接）
yyzzdm	string	是	社会统一信用代码
yyzz_images	string	是	营业执照照片（多个逗号拼接）
address	string	是	店铺地址
address_detail	string	是	店铺详细地址
longitude	string	是	经度
latitude	string	是	纬度
province	int	是	省编号
city	int	是	市编号
district	int	是	县区编号
establish_time	int	是	成立时间10位秒级时间戳
people	int	是	员工人数
legal_entity	string	是	法人姓名
gender	int	是	法人性别:0=女,1=男
nation	string	是	法人民族
out_look	string	是	法人政治面貌
birthtime	int	是	法人出生日期10位秒级时间戳
native_place	string	是	法人籍贯
card_number	string	是	法人身份证号码
diploma	string	是	法人学历
post	string	是	法人职务
social_position	string	是	法人社会职务

正文

无

参数

追加

name

logo

image

content

tel

desc

front_idcard_image

reverse_idcard_image

images

yyzzdm

yyzz_images

address

address_detail

longitude

latitude

province

city

district

establish_time

people

legal_entity

gender

nation

out_look

birthtime

native_place

card_number

diploma

post

social_position

响应输出

返回参数

无

{
     *
     *}

POST 机构申请新版接口 /api/school/shop/apply

机构申请新版接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
type	string	是	类型:1=个人,2=机构
name	string	是	机构名称（机构入驻才需要）
realname	string	是	联系人姓名
mobile	string	是	联系电话
address	string	是	地址

正文

无

参数

追加

type

name

realname

mobile

address

响应输出

返回参数

无

{
     *
     *}

课程支付接口

POST 课程第三方支付 /api/school/pay/payment

课程第三方支付（微信等支付）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单id或订单号
type	string	是	服务商:alipay=支付宝,wechat=微信
platform	string	是	平台:web=PC网页支付,wap=H5手机网页支付,app=APP支付,scan=扫码支付,mp=微信公众号支付,miniapp=微信小程序支付
openid	string	否	用户openid(非必填

正文

无

参数

追加

order_no

type

platform

openid

响应输出

返回参数

无

{
     *
     *}

GET 第三方支付支付成功回调 /api/school/pay/notifyx

第三方支付成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 支付返回，网页支付版本（小程序忽略） /api/school.pay/returnx

支付返回，网页支付版本（小程序忽略）

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET notifyRefund /api/school.pay/notifyRefund

notifyRefund

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 退款成功回调 /api/school.pay/notifyr

退款成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

用户端：课程订单接口

GET 订单详情 /api/school/order/detail

订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 订单确认/订单计算接口 /api/school/order/confirm

订单确认/订单计算接口【有过期时间】

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_lib_id	int	是	课程id
order_no	string	否	缓存key
classes_lib_spec_id	int	是	想同时约的课时id
is_compute	int	否	是否重新计算并更新缓存默认传1

正文

无

参数

追加

classes_lib_id

order_no

classes_lib_spec_id

is_compute

响应输出

返回参数

无

{
     *
     *}

POST 订单下单接口 /api/school/order/create

订单下单接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	缓存key

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 预约课时单取消接口 /api/school/order/cancel

预约课时单取消接口（已完成的单无法取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的订单列表接口 /api/school/order/order_list

我的订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：-3=已取消,0=待支付,3=使用中,6=已退款,9=已完成
classes_lib_id	int	否	课程id
has_evaluate	int	否	是否评价:默认0全部，1查已评价 2查未评价

正文

无

参数

追加

keywords

page

limit

status

classes_lib_id

has_evaluate

响应输出

返回参数

无

{
     *
     *}

GET 我的订单数量接口 /api/school/order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_lib_id	int	否	课程id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

教师接口

GET 老师详情 /api/school/teacher/detail

老师详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	老师id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 老师或专家列表（取决于搜索条件） /api/school/teacher/teacher_list

老师或专家列表（取决于搜索条件）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	查展示专家请传1，非专家也查请传0
recommend	string	否	平台首页推荐:0=否,1=是
shop_id	string	否	机构店铺id
user_id	string	否	教师用户id

正文

无

参数

追加

keywords

page

limit

status

recommend

shop_id

user_id

响应输出

返回参数

无

{
     *
     *}

用户端：课程订单售后接口

GET 售后订单详情 /api/school.service_order/detail

售后订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	售后订单id或售后订号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 订单申请售后接口 /api/school.service_order/create

订单申请售后

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_order_id	int	是	需要售后的课程订单id
reason	string	是	申请理由

正文

无

参数

追加

classes_order_id

reason

响应输出

返回参数

无

{
     *
     *}

POST 售后申请取消接口 /api/school.service_order/cancel

售后申请取消（处理中的无法再取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	售后订单id或售后订号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的售后订单列表接口 /api/school.service_order/order_list

我的售后订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：售后状态:1=待处理,4=处理中,7=已结单,-3=已取消
service_stauts	string	否	售后处理状态:1=待机构处理,4=待用户确认,7=售后通过结单中,10=售后结单完成,-3=售后驳回结单
sales_type	string	否	结单类型:-3=未结单,1=机构驳回,4=用户驳回,7=平台驳回,10=成功退款
classes_lib_id	int	否	课程id
classes_order_id	int	否	课程订单id
classes_order_detail_id	int	否	订单课程id

正文

无

参数

追加

keywords

page

limit

status

service_stauts

sales_type

classes_lib_id

classes_order_id

classes_order_detail_id

响应输出

返回参数

无

{
     *
     *}

GET 我的售后订单数量接口 /api/school.service_order/order_count

返回售后订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_lib_id	int	否	课程id
classes_order_id	int	否	课程订单id

正文

无

参数

追加

classes_lib_id

classes_order_id

响应输出

返回参数

无

{
     *
     *}

GET 我的售后订单记录列表接口 /api/school.service_order/order_log_list

我的售后订单记录列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	状态搜索条件：售后状态:1=待处理,4=处理中,7=已结单,-3=已取消
service_stauts	string	否	售后处理状态:1=待机构处理,4=待用户确认,7=售后通过结单中,10=售后结单完成,-3=售后驳回结单
sales_type	string	否	结单类型:-3=未结单,1=机构驳回,4=用户驳回,7=平台驳回,10=成功退款
classes_service_order_id	int	否	售后订单id

正文

无

参数

追加

keywords

page

limit

status

service_stauts

sales_type

classes_service_order_id

响应输出

返回参数

无

{
     *
     *}

POST 用户处理售后接口 /api/school.service_order/user_confirmation

用户处理售后接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	售后订单id或售后订号
status	string	是	yes=同意，no=驳回
reject_reason	string	否	驳回原因
reject_images	string	否	（非必填）驳回图片说明：多图逗号拼接

正文

无

参数

追加

order_no

status

reject_reason

reject_images

响应输出

返回参数

无

{
     *
     *}

用户端：帮助接口

GET 帮助文章列表接口 /api/school.help/article_list

帮助文章列表接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
help_cate_ids	string	否	帮助分类id
hot	string	否	平台热门:0=否,1=是
time	string	否	复合时间查询:today今天,week本周,month本月,year本年,yesterday昨天,last year上一年,last week上周，last month上個月，lately7最近7天， lately30最近30天，按开始时间区间查传值格式：Y/m/d H:M:S-Y/m/d H:M:S

正文

无

参数

追加

keywords

page

limit

help_cate_ids

hot

time

响应输出

返回参数

无

{
     *
     *}

GET 帮助分类列表接口 /api/school.help/cate_list

帮助分类列表接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
pid	string	是	父级id

正文

无

参数

追加

keywords

page

limit

pid

响应输出

返回参数

无

{
     *
     *}

GET 文章详情 /api/school.help/detail

文章详情

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	文章id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

员工管理机构课程接口

POST 员工课程添加 /api/school.worker.classes/add

员工课程添加

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
classes_num	int	是	核销次数
status	string	是	上架状态:1=上架,2=下架,3=平台下架
teacher_id	int	是	老师id
classes_type	string	是	课程类型
classes_cate_ids	string	是	课程标签ids 多值逗号拼接
classes_label_ids	string	是	课程热门标签
self_label_tag	string	是	机构热门标签：多值逗号拼接
title	string	是	课程标题
headimage	string	是	课程头图
images	string	是	课程轮播图多值逗号拼接
type	string	是	地点类型:out=户外,in=室内
spec	string	是	课时多规格：[{'id':665,'classes_lib_id':570,'name':'xxxxx','limit_num':100,'status':'1','weigh':665,'time':'2024/12/12 19:00 - 2024/12/12 20:00'}]
address_type	string	是	地址类型:1=按机构,2=独立位置
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
address	string	否	地图定位地址
address_detail	string	否	手录详细地址
longitude	string	否	经度
latitude	string	否	纬度
content	string	否	课程详情
notice	string	否	课程须知
price	string	否	课程价格 0为免费
selfhot	string	否	机构热门:0=否,1=是

正文

无

参数

追加

classes_num

status

teacher_id

classes_type

classes_cate_ids

classes_label_ids

self_label_tag

title

headimage

images

type

spec

address_type

province

city

district

address

address_detail

longitude

latitude

content

notice

price

selfhot

响应输出

返回参数

无

{
     *
     *}

POST 员工课程编辑 /api/school.worker.classes/edit

员工课程编辑

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	课程id
status	string	是	上架状态:1=上架,2=下架,3=平台下架
teacher_id	int	是	老师id
classes_type	string	是	课程类型
classes_cate_ids	string	是	课程标签ids 多值逗号拼接
classes_label_ids	string	是	课程热门标签
self_label_tag	string	是	机构热门标签：多值逗号拼接
title	string	是	课程标题
headimage	string	是	课程头图
images	string	是	课程轮播图多值逗号拼接
type	string	是	地点类型:out=户外,in=室内
spec	string	是	课时多规格：[{'id':665,'classes_lib_id':570,'name':'xxxxx','limit_num':100,'status':'1','weigh':665,'time':'2024/12/12 19:00 - 2024/12/12 20:00'}]
address_type	string	是	地址类型:1=按机构,2=独立位置
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
address	string	否	地图定位地址
address_detail	string	否	手录详细地址
longitude	string	否	经度
latitude	string	否	纬度
content	string	否	课程详情
notice	string	否	课程须知
price	string	否	课程价格 0为免费
selfhot	string	否	机构热门:0=否,1=是

正文

无

参数

追加

status

teacher_id

classes_type

classes_cate_ids

classes_label_ids

self_label_tag

title

headimage

images

type

spec

address_type

province

city

district

address

address_detail

longitude

latitude

content

notice

price

selfhot

响应输出

返回参数

无

{
     *
     *}

POST 员工课程批量删除 /api/school.worker.classes/del

员工课程批量删除

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	需要删除的一组课程id，多值逗号拼接

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 课程更改状态 /api/school.worker.classes/update_status

课程更改状态

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	需要更改状态的课程id
status	string	是	需要更改状态:1=上架,2=下架

正文

无

参数

追加

status

响应输出

返回参数

无

{
     *
     *}

实名认证接口

POST 更新或保存实名认证信息 /api/school.real_name/save

更新或保存实名认证信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	姓名
idnum	string	是	身份证号
positive_img	string	是	身份证正面
back_img	string	是	身份证反面

正文

无

参数

追加

name

idnum

positive_img

back_img

响应输出

返回参数

无

{
     *
     *}

GET 实名认证信息查询 /api/school.real_name/info

实名认证信息查询

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

Token接口

GET 检测Token是否过期 /api/token/check

检测Token是否过期

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 刷新Token /api/token/refresh

刷新Token

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

验证接口

POST 检测邮箱 /api/validate/check_email_available

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
id	string	是	排除会员ID

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测用户名 /api/validate/check_username_available

检测用户名

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
id	string	是	排除会员ID

正文

无

参数

追加

username

响应输出

返回参数

无

无

POST 检测昵称 /api/validate/check_nickname_available

检测昵称

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
nickname	string	是	昵称
id	string	是	排除会员ID

正文

无

参数

追加

nickname

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_available

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
id	string	是	排除会员ID

正文

无

参数

追加

mobile

响应输出

返回参数

无

无

POST 检测手机 /api/validate/check_mobile_exist

检测手机

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测邮箱 /api/validate/check_email_exist

检测邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测手机验证码 /api/validate/check_sms_correct

检测手机验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

mobile

captcha

event

响应输出

返回参数

无

无

POST 检测邮箱验证码 /api/validate/check_ems_correct

检测邮箱验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码
event	string	是	事件

正文

无

参数

追加

captcha

event

响应输出

返回参数

无

无

首页接口

GET 执行sql脚本 /api/index/index

执行sql脚本

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
page	int	否	页数
limit	int	否	每页条数

正文

无

参数

追加

page

limit

响应输出

返回参数

无

无

GET 各种协议文章 /api/index/agreement

about_us 关于夜校 entry_agreement 入驻协议 privacy 隐私协议 user_protocol 用户协议

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET init接口，小程序初始化参数接口 /api/index/init

小程序初始化参数接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 省市区数据 /api/index/area

省市区数据

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 省市区数据预加载接口 /api/index/get_area

省市区数据预加载接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
province	string	否	省编号
city	string	否	市编号

正文

无

参数

追加

province

city

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序访问分析 /api/index/getWeanalysisAppidDailyVisittrend

微信小程序访问分析

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
begin_date	string	是	开始日期。格式为 yyyymmdd 如：20170611 开始日期
end_date	string	是	结束日期，格式为 yyyymmdd 如：20170611 结束日期，限定查询1天数据，end_date允许设置的最大值为昨日

正文

无

参数

追加

begin_date

end_date

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

示例接口

POST 测试名称 /api/demo/test/id/{id}/name/{name}

测试描述信息

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
token	string	是	请求的Token

参数

名称	类型	必选	描述
id	integer	是	会员ID
name	string	是	用户名
data	object	是	扩展数据

正文

无

Headers

token

参数

追加

name

data

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	object	扩展数据返回

{
         'code':'1',
         'msg':'返回成功'
        }

GET 无需登录的接口 /api/demo/test1

无需登录的接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录的接口 /api/demo/test2

需要登录的接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 需要登录且需要验证有相应组的权限 /api/demo/test3

需要登录且需要验证有相应组的权限

权限

登录	是
鉴权	是

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

邮箱验证码接口

POST 发送验证码 /api/ems/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称

正文

无

参数

追加

event

响应输出

返回参数

无

无

POST 检测验证码 /api/ems/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

event

captcha

响应输出

返回参数

无

无

敏感词接口

GET 生成敏感词json文件 /api/sensitivewords/sensitivewords_generate_json

生成敏感词json文件

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 检测敏感词是否存在 /api/sensitivewords/check

检测敏感词是否存在

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
text	string	是	敏感词
excption	int	是	是否报错

正文

无

参数

追加

text

excption

响应输出

返回参数

无

{
     *
     *}

POST 检测敏感词并替换 /api/sensitivewords/check_and_replace

检测敏感词并替换

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
text	string	是	敏感词
replace	string	是	替换符号

正文

无

参数

追加

text

replace

响应输出

返回参数

无

{
     *
     *}

手机短信接口

POST 发送验证码 /api/sms/send

发送验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称

正文

无

参数

追加

mobile

event

响应输出

返回参数

无

无

POST 检测验证码 /api/sms/check

检测验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
event	string	是	事件名称
captcha	string	是	验证码

正文

无

参数

追加

mobile

event

captcha

响应输出

返回参数

无

无

本服务器openid:用户开放接口

POST 用户中心 /api/openapi.user/index

用户中心

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
key	string	否	调用key
encryption_data	string	是	加密数据
sign	string	是	签名

正文

无

参数

追加

key

encryption_data

sign

响应输出

返回参数

无

{
     *
     *}

GET checkToken /api/openapi.user/checkToken

checkToken

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

Base

GET checkToken /api/openapi.base/checkToken

checkToken

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

公共接口

GET 加载初始化 /api/common/init

加载初始化

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
version	string	是	版本号
lng	string	是	经度
lat	string	是	纬度

正文

无

参数

追加

version

lng

lat

响应输出

返回参数

无

无

POST 用户上传文件 /api/common/upload

用户上传文件

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
file	File	是	文件流
category	string	是	分类标识：category1=非机密类1,category2=非机密类2,cert=证件机密类,code=二维码类,user=用户普通上传

正文

无

参数

追加

file

GET 验证码 /api/common/captcha

验证码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	要生成验证码的标识

正文

无

参数

追加

响应输出

返回参数

无

无

GET 生成随机昵称和头像 /api/common/virtualgenerate

生成随机昵称和头像

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
number	int	是	生成数量

正文

无

参数

追加

响应输出

返回参数

无

{ unpaid_user_data 参与中  paid_user_data 已报名 }

GET 通过时间点得到当前的星期数据 /api/common/get_week_by_time

通过时间点得到当前的星期数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	是	选择的时间点

正文

无

参数

追加

响应输出

返回参数

无

{ unpaid_user_data 参与中  paid_user_data 已报名 }

BailianMcp

GET stream /api/mcp.bailian_mcp/stream

stream

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET healthCheck /api/mcp.bailian_mcp/healthCheck

healthCheck

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

课程接口

GET 课程查询参数接口 /api/school/classes/index

课程查询参数接口

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{

     *
     *}

GET 课程详情接口 /api/school/classes/detail

课程详情接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	课程id

正文

无

参数

追加

响应输出

返回参数

无

{

     *
     *}

GET 课程参与者和报名者 /api/school/classes/people

课程参与者和报名者

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	课程id
have_real	int	是	是否只查真實的 1是 0否

正文

无

参数

追加

have_real

响应输出

返回参数

无

{ unpaid_user_data 参与中  paid_user_data 已报名 }

GET 课程课时规格 /api/school/classes/spec

课程课时规格

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	课程id
user_id	int	是	需要查询是否下单的用户id

正文

无

参数

追加

user_id

响应输出

返回参数

无

{ spec 课时规格 }

GET 课程分类列表 /api/school/classes/cate_list

课程分类列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
hot	string	否	状态搜索条件：-1=全部分类,0=非热门分类,1=热门分类

正文

无

参数

追加

keywords

page

limit

hot

响应输出

返回参数

无

{
     *
     *}

GET 课程类型列表 /api/school/classes/type_list

课程类型列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数

正文

无

参数

追加

keywords

page

limit

响应输出

返回参数

无

{
     *
     *}

GET 课程标签列表 /api/school/classes/label_list

课程标签列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数

正文

无

参数

追加

keywords

page

limit

响应输出

返回参数

无

{
     *
     *}

GET 通用课程大索索列表 /api/school/classes/classes_list

通用课程大索索列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
start_time	int	否	开始时间10位秒级时间戳
end_time	int	否	结束时间10位秒级时间戳
has_shop	int	否	是否查机构
is_expire	int	否	是否查过期：1只查过期,2只查不过期,0全查
user_id	int	否	主讲师用户id
shop_id	int	否	机构店铺id
teacher_id	int	否	老师id
classes_cate_ids	string	否	平台课程分类ids
classes_label_ids	string	否	平台课程热门标签ids
self_label_tag	string	否	机构特色标签
classes_type	string	否	平台课程类型
keyword	string	否	关键字搜索
type	string	否	地点类型:out=户外,in=室内
address_type	string	否	地址类型:1=按机构,2=独立位置
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
status	string	否	不传则默认查上架的状态: 1=上架,2=下架,3=平台下架
recommend	string	否	平台推荐:0=否,1=是
hot	string	否	平台热门:0=否,1=是
new	string	否	平台最新:0=否,1=是
selfhot	string	否	机构热门:0=否,1=是
feel	string	否	是否免费:0=否,1=是
collect	int	否	是否专查我的收藏(需登录
order	string	否	normal=综合排序推薦優先,distance=距离优先,hot=熱門优先,new=平台最新优先,selfhot=机构热门优先,sale=銷量优先,views=浏览量优先,collect=收藏量优先
nearby	string	否	限制最大搜索距离（米）
latitude	string	否	latitude
longitude	string	否	longitude
auth_status	string	否	审核状态:-1=不计入条件 ,0=待审核,1=审核通过,2=审核失败

正文

无

参数

追加

keywords

page

limit

start_time

end_time

has_shop

is_expire

user_id

shop_id

teacher_id

classes_cate_ids

classes_label_ids

self_label_tag

classes_type

keyword

type

address_type

province

city

district

status

recommend

hot

new

selfhot

feel

collect

order

nearby

latitude

longitude

auth_status

响应输出

返回参数

无

{
     *
     *}

POST 设置课程收藏和取消收藏 /api/school/classes/collect

设置课程收藏和取消收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	课程id
is_collect	int	是	收藏操作：0取消收藏，1收藏

正文

无

参数

追加

is_collect

响应输出

返回参数

无

{
     *
     *}

mcp服务demo

GET @return void /api/mcp.demo/sse

@return void

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

会员接口

GET 获取抖音小程序openid信息 /api/user/getTtOpenid

根据前端code换取openid信息

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
code	string	是	前端code值

正文

无

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	bject	扩展数据

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 获取微信小程序openid信息 /api/user/getOpenid

根据前端code换取openid信息

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
brand-key	string	否	应用key
token	string	否	Token

参数

名称	类型	必选	描述
code	string	是	前端code值

正文

无

Headers

brand-key

token

参数

追加

响应输出

返回参数

名称	类型	描述
code	integer
msg	string
data	bject	扩展数据

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信加密信息解密 /api/user/decodeData

微信解密微信信息

权限

登录	否
鉴权	否

Headers

名称	类型	必选	描述
brand-key	string	否	应用key
token	string	否	Token

参数

名称	类型	必选
iv	string	是
encryptedData	string	是
sessionKey	string	是

正文

无

Headers

brand-key

token

参数

追加

encryptedData

sessionKey

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 抖音小程序加密信息解密 /api/user/decodeTtData

解密抖音小程序返回的加密数据

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
iv	string	是	初始向量
encryptedData	string	是	加密数据
sessionKey	string	是	会话密钥

正文

无

参数

追加

encryptedData

sessionKey

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

POST 微信小程序授权登录注册通用[支持静默登录] /api/user/registerLogin

登录注册通用-支持静默登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	否	mobile 静默非必传,手机授权必传
unionid	string	否	unionid 非必传
apptype	string	否	应用类型默认miniapp
platform	string	是	平台标识默认wechat微信，tt抖音
openid	string	是	授权的openid
keeptime	string	是	token保持时间，默认0永久
code	string	是	授权的code

正文

无

参数

追加

mobile

unionid

apptype

platform

openid

keeptime

code

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {‘token’：xxxxx,'errcode':0(如果为30001则是需要重新授权

GET 会员中心 /api/user/index

会员中心

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 会员登录 /api/user/login

会员登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
account	string	是	账号
password	string	是	密码

正文

无

参数

追加

account

password

响应输出

返回参数

无

无

POST 手机验证码登录 /api/user/mobilelogin

手机验证码登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 注册会员 /api/user/register

注册会员

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
username	string	是	用户名
password	string	是	密码
email	string	是	邮箱
mobile	string	是	手机号
code	string	是	验证码

正文

无

参数

追加

username

password

mobile

code

响应输出

返回参数

无

无

POST 退出登录 /api/user/logout

退出登录

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

POST 修改会员个人信息 /api/user/profile

修改会员个人信息

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
update_fields	string	是	本次需要更新的用户字段json格式：更新谁传谁的字段名，比如：只更新头像和昵称则 json=['avatar','nickname']
avatar	string	是	头像地址
username	string	是	用户名
nickname	string	是	昵称
realname	string	是	姓名
gender	int	是	性别：0女 1男
birthday	string	是	出生日期：日期字符串比如”1995-9-20
work	string	是	职业
bio	string	是	个人简介

正文

无

参数

追加

update_fields

avatar

username

nickname

realname

gender

birthday

work

bio

响应输出

返回参数

无

无

POST 修改邮箱 /api/user/changeemail

修改邮箱

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
email	string	是	邮箱
captcha	string	是	验证码

正文

无

参数

追加

captcha

响应输出

返回参数

无

无

POST 修改手机号 /api/user/changemobile

修改手机号

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
captcha	string	是	验证码

正文

无

参数

追加

mobile

captcha

响应输出

返回参数

无

无

POST 第三方登录 /api/user/third

第三方登录

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
platform	string	是	平台名称
code	string	是	Code码

正文

无

参数

追加

platform

code

响应输出

返回参数

无

无

POST 重置密码 /api/user/resetpwd

重置密码

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
mobile	string	是	手机号
newpassword	string	是	新密码
captcha	string	是	验证码

正文

无

参数

追加

mobile

newpassword

captcha

响应输出

返回参数

无

无

GET 获取跳转小程序自动登录传参 /api/user/auto_login_token

获取跳转小程序自动登录传参

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
encryption	string	否	是否公钥加密 1是，0否, 默认是

正文

无

参数

追加

响应输出

返回参数

无

无

用户机构授权接口

GET 我的授权详情 /api/school.user_auth/detail

我的授权详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	授权id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的授权信息列表（取决于搜索条件） /api/school.user_auth/auth_list

我的授权信息列表（取决于搜索条件）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
page	string	是	页数
limit	string	是	条数
status	string	否	授权状态:1=通过,2=拒绝
shop_id	int	否	机构店铺id

正文

无

参数

追加

page

limit

status

shop_id

响应输出

返回参数

无

{
     *
     *}

POST 用户机构授权 /api/school.user_auth/authorization

支持用户主动授权和确认表单两种形式

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	否	非必填，确认表单才需要填
shop_id	int	是	机构店铺id
status	int	是	授权操作：1=通过,2=拒绝

正文

无

参数

追加

shop_id

status

响应输出

返回参数

无

{
     *
     *}

用户端：结算记录相关接口

GET 结算记录接口（收益明细） /api/school.newactivity.settle_log/settle_log

我的结算记录接口（收益明细）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	结算状态:1=冻结中,2=待结算,3=已结算
activity_id	int	否	活动id

正文

无

参数

追加

keywords

page

limit

status

activity_id

响应输出

返回参数

无

{
     *
     *}

GET 我的提现记录 /api/school.newactivity.settle_log/withdrawal_log

我的提现记录列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	提现申请状态:1=待审核,2=审核通过,3=审核不通过
withdrawal_status	string	否	打款状态:1=未打款,2=打款中,3=已打款

正文

无

参数

追加

keywords

page

limit

status

withdrawal_status

响应输出

返回参数

无

{
     *
     *}

GET 我的提现记录详情 /api/school.newactivity.settle_log/withdrawal_log_detail

我的提现记录详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	记录id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的提现银行卡信息（未绑数据为null） /api/school.newactivity.settle_log/detail

我的提现银行卡信息

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 更新或保存提现银行卡 /api/school.newactivity.settle_log/save

更新或保存提现银行卡

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	string	是	转账账户名
bank_name	string	是	开户行名称（具体到支行）
bank_user_name	string	是	银行账户号
id_number	string	是	身份证号

正文

无

参数

追加

name

bank_name

bank_user_name

id_number

响应输出

返回参数

无

{
     *
     *}

POST 申请银行卡提现 /api/school.newactivity.settle_log/withdrawal

申请银行卡提现

权限

登录	是
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

用户参加成员管理

GET 成员列表接口 /api/school.newactivity.activity_join/people_list

成员列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数

正文

无

参数

追加

keywords

page

limit

响应输出

返回参数

无

{
     *
     *}

GET 成员详情 /api/school.newactivity.activity_join/detail

成员详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	成员id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 删除成员 /api/school.newactivity.activity_join/del

删除成员

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	要删除的ids

正文

无

参数

追加

响应输出

返回参数

无

无

POST 添加成员 /api/school.newactivity.activity_join/add

添加成员

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
name	int	是	姓名
idnum	string	是	身份证号

正文

无

参数

追加

name

idnum

响应输出

返回参数

无

{
     *
     *}

POST 编辑成员 /api/school.newactivity.activity_join/edit/ids/{ids}

编辑成员

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
ids	string	是	需要编辑的id
name	int	是	姓名
idnum	string	是	身份证号

正文

无

参数

追加

ids

name

idnum

响应输出

返回参数

无

{
     *
     *}

新活动支付接口

POST 活动第三方支付 /api/school.newactivity.pay/payment

活动第三方支付（微信等支付）

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单id或订单号
type	string	是	服务商:alipay=支付宝,wechat=微信
platform	string	是	平台:web=PC网页支付,wap=H5手机网页支付,app=APP支付,scan=扫码支付,mp=微信公众号支付,miniapp=微信小程序支付
openid	string	否	用户openid(非必填

正文

无

参数

追加

order_no

type

platform

openid

响应输出

返回参数

无

{
     *
     *}

GET 第三方支付支付成功回调 /api/school.newactivity.pay/notifyx

第三方支付成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 支付返回，网页支付版本（小程序忽略） /api/school.newactivity.pay/returnx

支付返回，网页支付版本（小程序忽略）

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 支付返回 /api/school.newactivity.pay/notifyRefund

支付返回

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 退款成功回调 /api/school.newactivity.pay/notifyr

退款成功回调

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

用户端：新活动订单接口

GET 我的活动订单详情 /api/school.newactivity.order/detail

我的活动订单详情

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	订单id或订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

GET 我的活动订单列表接口 /api/school.newactivity.order/order_list

我的活动订单列表接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
status	string	否	订单状态:-3=已取消,0=待支付,2=已报名,3=核销中,4=售后中,5=退款结算中,6=已退款,9=已完成
server_status	string	否	售后订单状态:0=正常,3=售后中,6=售后完成
auth_status	string	否	售后结果状态:0=待审核,1=同意退款,2=拒绝退款
invoice_status	string	否	发票申请状态:0=未申请,1=申请中,2=已开票
have_invoice	int	否	是否查可开票:1是
activity_id	int	否	活动id

正文

无

参数

追加

keywords

page

limit

status

server_status

auth_status

invoice_status

have_invoice

activity_id

响应输出

返回参数

无

{
     *
     *}

GET 我的活动订单数量接口 /api/school.newactivity.order/order_count

返回订单各个数量

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
activity_id	int	否	活动id（非必填）

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 订单确认/订单计算接口 /api/school.newactivity.order/confirm

订单确认/订单计算接口【有过期时间】

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
num	int	是	人数
activity_id	int	是	活动id
order_no	string	否	缓存key
people	string	是	(需url编码
is_compute	int	否	是否重新计算并更新缓存默认传1
desc	string	否	下单备注

正文

无

参数

追加

num

activity_id

order_no

people

is_compute

desc

响应输出

返回参数

无

{
     *
     *}

POST 订单下单接口 /api/school.newactivity.order/create

订单下单接口

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	缓存key

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 免费单和未支付单取消接口 /api/school.newactivity.order/freecancel

活动单取消接口（免费单和未支付单取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 付费活动支付后取消接口 /api/school.newactivity.order/paidcancel

付费活动支付后取消接口（支付后，活动开始前）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	订单号

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 订单申请售后接口 /api/school.newactivity.order/after_sales

订单申请售后

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
order_no	string	是	需要售后的订单号
auth_reason	string	是	申请理由
num	int	是	退票数

正文

无

参数

追加

order_no

auth_reason

num

响应输出

返回参数

无

{
     *
     *}

新活动接口

GET 活动分类列表 /api/school.new_activity/cate_list

活动分类列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数
hot	string	否	状态搜索条件：-1=全部分类,0=非热门分类,1=热门分类

正文

无

参数

追加

keywords

page

limit

hot

响应输出

返回参数

无

{
     *
     *}

GET 通用活动大索索列表 /api/school.new_activity/activity_list

通用活动大索索列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
platform	string	否	上架平台:wechat_miniapp=微信小程序,tt_miniapp=抖音小程序
my	string	是	是否查自己(需登录
page	string	是	页数
limit	string	是	条数
start_time	int	否	开始时间10位秒级时间戳
end_time	int	否	结束时间10位秒级时间戳
sign_start_time	int	否	报名开始时间10位秒级时间戳
sign_end_time	int	否	报名结束时间10位秒级时间戳
auth_status	int	否	审核状态:0=待审核,1=审核通过,2=审核不通过 ,不传查所有，可按多值逗号拼接
cate_ids	string	否	平台分类ids 多值逗号拼接
province	string	否	省编号
city	string	否	市编号
district	string	否	县区编号
status	string	否	状态:1=未开始,2=报名中,3=待开始,4=进行中,5=已结束,-1=已取消 ,不传查所有，可按多值逗号拼接
recommend	string	否	平台推荐:0=否,1=是
hot	string	否	平台热门:0=否,1=是
new	string	否	平台最新:0=否,1=是
selfhot	string	否	机构热门:0=否,1=是
feel	string	否	是否免费:0=否,1=是
collect	int	否	是否专查我的收藏(需登录
order	string	否	normal=综合排序推薦優先,distance=距离优先,hot=熱門优先,new=平台最新优先,sale=銷量优先,views=浏览量优先,collect=收藏量优先
nearby	string	否	限制最大搜索距离（米）
latitude	string	否	latitude
longitude	string	否	longitude

正文

无

参数

追加

keywords

platform

page

limit

start_time

end_time

sign_start_time

sign_end_time

auth_status

cate_ids

province

city

district

status

recommend

hot

new

selfhot

feel

collect

order

nearby

latitude

longitude

响应输出

返回参数

无

{
     *
     *}

GET 活动详情接口 /api/school.new_activity/detail

活动详情接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动id

正文

无

参数

追加

响应输出

返回参数

无

{

     *
     *}

POST 设置活动收藏和取消收藏 /api/school.new_activity/collect

设置活动收藏和取消收藏

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	int	是	活动id
is_collect	int	是	收藏操作：0取消收藏，1收藏

正文

无

参数

追加

is_collect

响应输出

返回参数

无

{
     *
     *}

POST 活动添加 /api/school.new_activity/add

活动添加

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
cate_ids	string	是	平台分类ids 多值逗号拼接
refund_id	int	是	退款策略id
title	string	是	标题
sign_time	string	是	报名区间示例： 2025-04-08 00:01:00 - 2025-04-08 15:29:00
time	string	是	活动区间示例： 2025-04-09 00:01:00 - 2025-04-09 15:29:00
platform	string	否	上架平台:wechat_miniapp=微信小程序,tt_miniapp=抖音小程序
images	string	是	轮播图多值逗号拼接
address	string	否	地图定位地址
address_detail	string	否	手录详细地址
longitude	string	否	经度
latitude	string	否	纬度
content	string	否	活动详情
price	string	否	报名单价 0为免费
stock	string	否	活动限制人数
image	string	否	入群二维码

正文

无

参数

追加

cate_ids

refund_id

title

sign_time

time

platform

images

address

address_detail

longitude

latitude

content

price

stock

image

响应输出

返回参数

无

{
     *
     *}

GET 退款策略列表 /api/school.new_activity/refund_list

退款策略列表

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
keywords	string	否	搜索关键字
page	string	是	页数
limit	string	是	条数

正文

无

参数

追加

keywords

page

limit

响应输出

返回参数

无

{
     *
     *}

POST 活动取消 /api/school.new_activity/cancel

活动取消）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	活动id

正文

无

参数

追加

响应输出

返回参数

无

{
     *
     *}

POST 活动更换入群二维码 /api/school.new_activity/edit_qrcode

活动更换入群二维码）

权限

登录	是
鉴权	否

Headers

无

参数

名称	类型	必选	描述
id	string	是	活动id
image	string	是	加群二维码

正文

无

参数

追加

image

响应输出

返回参数

无

{
     *
     *}

数据驾驶舱接口

GET 按区域统计接口 /api/school.big_data/getAreaBaseData

按区域统计接口

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
province	string	否	省编号（非必填）
city	string	否	市编号（非必填）
district	string	否	区域编号（非必填）

正文

无

参数

追加

province

city

district

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 按课程类型统计累计报名人数 /api/school.big_data/accumulatedNumberOfApplicants

按课程类型统计累计报名人数

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 各区域上课数量和上课人数 /api/school.big_data/numberOfClassesInEachRegion

各区域上课数量和上课人数

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
province	string	否	省编号（非必填）
city	string	否	市编号（非必填）
time	string	否	复合时间查询:today今天,week本周,month本月,year本年,yesterday昨天,last year上一年,last week上周，last month上個月，lately7最近7天， lately30最近30天，按开始时间区间查传值格式：Y/m/d H:M:S-Y/m/d H:M:S

正文

无

参数

追加

province

city

time

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 按课程类型统计七天内报名人数 /api/school.big_data/accumulatedSevenNumberOfApplicants

按课程类型统七天内报名人数

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 前N名累计活跃课程 /api/school.big_data/topNCumulativeActiveCourses

前N名累计活跃课程

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
number	string	否	前N名累计活跃课程

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 七天内活动报名人数和活跃热度 /api/school.big_data/accumulatedSevenNumberOfActivity

七天内活动报名人数和活跃热度

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 得到七天内日期 /api/school.big_data/getLastSevenDaysDate

得到七天内日期

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	否	计算的当前时间戳

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 得到上个月日期 /api/school.big_data/getLastMonthDate

得到上个月日期

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	否	计算的当前时间戳

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 得到上个天日期 /api/school.big_data/getLastDaysDate

得到上个天日期

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	否	计算的当前时间戳

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 得到上周日期 /api/school.big_data/getLastWeekDate

得到上周日期

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	否	计算的当前时间戳

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 得到前30天日期 /api/school.big_data/getLastThirtyDaysDate

得到前30天日期

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
time	string	否	计算的当前时间戳

正文

无

参数

追加

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

GET 访问来源统计 /api/school.big_data/visitDistribution

访问来源统计

权限

登录	否
鉴权	否

Headers

无

参数

名称	类型	必选	描述
start_time	string	否	开始时间
end_time	string	否	结束时间

正文

无

参数

追加

start_time

end_time

响应输出

返回参数

无

{
    "code" => 1,
    "msg" => "获取成功",
    "data" => {}
     *}

Class Crontab

GET 每天执行的任务 /api/crontab/day

每天执行的任务

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无

GET 每1分钟执行的任务 /api/crontab/minute

每1分钟执行的任务

权限

登录	否
鉴权	否

Headers

无

参数

无

正文

无

参数

追加

响应输出

返回参数

无

无