系统配置模块
接口系统控制器,负责在线修改配置文件,在线重启RuleAPI接口
类路径:SystemController
前缀:/system
1. isKey
接口路径:GET/POST /system/isKey
权限:公开接口,不校验 token
接口说明:验证Key
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
2. getConfig
接口路径:GET/POST /system/getConfig
权限:需要超级管理员权限
接口说明:配置文件读取
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
3. setupWebKey
接口路径:GET/POST /system/setupWebKey
权限:需要超级管理员权限
接口说明:网站基本信息配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
4. setupCache
接口路径:GET/POST /system/setupCache
权限:需要超级管理员权限
接口说明:缓存配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
5. setupMysql
接口路径:GET/POST /system/setupMysql
权限:需要超级管理员权限
接口说明:数据库配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
6. setupRedis
接口路径:GET/POST /system/setupRedis
权限:需要超级管理员权限
接口说明:Redis配置,包括数据前缀
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
7. setupEmail
接口路径:GET/POST /system/setupEmail
权限:需要超级管理员权限
接口说明:邮件发送配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
8. setupConfig
接口路径:GET/POST /system/setupConfig
权限:需要超级管理员权限
接口说明:编辑配置文件
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
9. allConfig
接口路径:GET/POST /system/allConfig
权限:需要超级管理员权限
接口说明:获取所有配置信息
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
10. getApiConfig
接口路径:GET/POST /system/getApiConfig
权限:公开接口,不校验 token
接口说明:获取数据库中的配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
11. apiConfigUpdate
接口路径:GET/POST /system/apiConfigUpdate
权限:公开接口,不校验 token
接口说明:配置修改
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
12. apiNewVersion
接口路径:GET/POST /system/apiNewVersion
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:获取新版本
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
13. taskAds
接口路径:GET/POST /system/taskAds
权限:公开接口,不校验 token
接口说明:外部任务(广告)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
14. autoReceiveOrder
接口路径:GET/POST /system/autoReceiveOrder
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:自动收货定时任务接口 监听所有status为Progress且arrivalTime>0的订单 如果超过6天未收货,发送即将自动收货通知(只发送一次) 如果超过7天未收货,自动完成订单并结算资金
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
15. taskRemoveOrder
接口路径:GET/POST /system/taskRemoveOrder
权限:公开接口,不校验 token
接口说明:外部任务(定时清理订单)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
16. getCRCloud
接口路径:GET/POST /system/getCRCloud
权限:公开接口,不校验 token
接口说明:CR云控信息
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
17. sendPushMsg
接口路径:GET/POST /system/sendPushMsg
权限:需要超级管理员权限
接口说明:发送状态栏通知
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| cid | String | 否 | - | |
| title | String | 否 | - | |
| content | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
18. addVipType
接口路径:GET/POST /system/addVipType
权限:需要超级管理员权限
接口说明:添加VIP类型
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
19. updateVipType
接口路径:GET/POST /system/updateVipType
权限:需要超级管理员权限
接口说明:修改VIP类型
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
20. deleteVipType
接口路径:GET/POST /system/deleteVipType
权限:需要超级管理员权限
接口说明:删除VIP类型
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
21. vipTypeList
接口路径:GET/POST /system/vipTypeList
权限:公开接口,不校验 token
接口说明:查询VIP类型
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.vipTypeList() (https://api.ruletree.club/system/vipTypeList)
22. addApp
接口路径:GET/POST /system/addApp
权限:需要超级管理员权限
接口说明:添加应用
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
23. updateApp
接口路径:GET/POST /system/updateApp
权限:需要超级管理员权限
接口说明:修改应用
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
24. deleteApp
接口路径:GET/POST /system/deleteApp
权限:需要超级管理员权限
接口说明:删除App
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
25. appList
接口路径:GET/POST /system/appList
权限:需要超级管理员权限
接口说明:查询APP列表
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
26. app
接口路径:GET/POST /system/app
权限:公开接口,不校验 token
接口说明:查询APP详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
27. addPayPackage
接口路径:GET/POST /system/addPayPackage
权限:需要超级管理员权限
接口说明:添加支付套餐
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
28. updatePayPackage
接口路径:GET/POST /system/updatePayPackage
权限:需要超级管理员权限
接口说明:修改应用
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.EPay() (https://api.ruletree.club/pay/EPay)
29. deletePayPackage
接口路径:GET/POST /system/deletePayPackage
权限:需要超级管理员权限
接口说明:删除App
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.EPay() (https://api.ruletree.club/pay/EPay)
30. payPackageList
接口路径:GET/POST /system/payPackageList
权限:需要登录(普通用户及以上)
接口说明:查询支付套餐列表
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.payPackageList() (https://api.ruletree.club/system/payPackageList)
31. getEmailTemplateConfig
接口路径:GET/POST /system/getEmailTemplateConfig
权限:完全公开,不做任何校验
接口说明:获取邮件模板配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
32. emailTemplateConfigUpdate
接口路径:GET/POST /system/emailTemplateConfigUpdate
权限:需要超级管理员权限
接口说明:配置修改
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
33. getAllConfig
接口路径:GET/POST /system/getAllConfig
权限:需要超级管理员权限
接口说明:获取2.0数据库中的配置
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
34. allConfigUpdate
接口路径:GET/POST /system/allConfigUpdate
权限:需要超级管理员权限
接口说明:配置修改
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| webkey | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
35. newVersion
接口路径:GET/POST /system/newVersion
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:商业版专用,获取
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
36. addCarousel
接口路径:GET/POST /system/addCarousel
权限:需要超级管理员权限
接口说明:添加轮播
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
37. updateCarousel
接口路径:GET/POST /system/updateCarousel
权限:需要超级管理员权限
接口说明:修改轮播
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
38. deleteCarousel
接口路径:GET/POST /system/deleteCarousel
权限:需要超级管理员权限
接口说明:删除App
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
39. carouselList
接口路径:GET/POST /system/carouselList
权限:公开接口,不校验 token
接口说明:查询轮播列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| order | String | 否 | orderKey |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.carouselList() (https://api.ruletree.club/system/carouselList)
40. addNavigation
接口路径:GET/POST /system/addNavigation
权限:需要超级管理员权限
接口说明:添加导航
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
41. updateNavigation
接口路径:GET/POST /system/updateNavigation
权限:需要超级管理员权限
接口说明:修改轮播
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
42. deleteNavigation
接口路径:GET/POST /system/deleteNavigation
权限:需要超级管理员权限
接口说明:删除App
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| webkey | String | 否 | - | |
| id | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
43. navigationList
接口路径:GET/POST /system/navigationList
权限:公开接口,不校验 token
接口说明:查询轮播列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| order | String | 否 | orderKey |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.navigationList() (https://api.ruletree.club/system/navigationList)