用户模块
控制层 TypechoUsersController @author buxia97 @date 2021/11/29
类路径:UsersController
前缀:/typechoUsers
1. userList
接口路径:GET/POST /typechoUsers/userList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:用户查询 @param searchParams Bean对象JSON字符串 @param page 页码 @param limit 每页显示数量
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| searchKey | String | 否 | - | |
| order | String | 否 | - | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | created |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getUserList() (https://api.ruletree.club/typechoUsers/userList)
2. userData
接口路径:GET/POST /typechoUsers/userData
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:用户数据
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | 0 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getUserData() (https://api.ruletree.club/typechoUsers/userData)
3. userInfo
接口路径:GET/POST /typechoUsers/userInfo
权限:公开接口,不校验 token
接口说明:用户信息
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getUserInfo() (https://api.ruletree.club/typechoUsers/userInfo)
4. userLogin
接口路径:GET/POST /typechoUsers/userLogin
权限:公开接口,不校验 token
接口说明:登陆 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| deviceType | String | 否 | web |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userLogin() (https://api.ruletree.club/typechoUsers/userLogin)
5. apiLogin
接口路径:GET/POST /typechoUsers/apiLogin
权限:公开接口,不校验 token
接口说明:社会化登陆 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| deviceType | String | 否 | app |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userApi() (https://api.ruletree.club/typechoUsers/apiLogin)
6. getWeixinQrStatus
接口路径:GET/POST /typechoUsers/getWeixinQrStatus
权限:公开接口,不校验 token
接口说明:社会化登陆 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| sceneId | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getWeixinQrStatus() (https://api.ruletree.club/typechoUsers/getWeixinQrStatus)
7. callback
接口路径:GET/POST /typechoUsers/weixinQrCallback
权限:公开接口,不校验 token
接口说明:社会化登陆 @param params Bean对象JSON字符串
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
8. getWexinScan
接口路径:GET/POST /typechoUsers/getWexinScan
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:社会化登陆 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| codeContent | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getWexinScan() (https://api.ruletree.club/typechoUsers/getWexinScan)
9. phoneLogin
接口路径:GET/POST /typechoUsers/phoneLogin
权限:公开接口,不校验 token
接口说明:快捷登录
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| phone | String | 否 | - | |
| area | String | 否 | +86 | |
| code | String | 否 | - | |
| deviceType | String | 否 | app |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.phoneLogin() (https://api.ruletree.club/typechoUsers/phoneLogin)
10. apiBind
接口路径:GET/POST /typechoUsers/apiBind
权限:需要登录(普通用户及以上)
接口说明:社会化登陆绑定 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.apiBind() (https://api.ruletree.club/typechoUsers/apiBind)
11. apiBindDelete
接口路径:GET/POST /typechoUsers/apiBindDelete
权限:需要登录(普通用户及以上)
接口说明:社会化登陆解除绑定
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| appLoginType | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.apiBind() (https://api.ruletree.club/typechoUsers/apiBind)
- 前端调用:this.$API.apiBindDelete() (https://api.ruletree.club/typechoUsers/apiBindDelete)
12. userBindStatus
接口路径:GET/POST /typechoUsers/userBindStatus
权限:需要登录(普通用户及以上)
接口说明:用户绑定查询
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userBindStatus() (https://api.ruletree.club/typechoUsers/userBindStatus)
13. userRegister
接口路径:GET/POST /typechoUsers/userRegister
权限:公开接口,不校验 token
接口说明:注册用户 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userRegister() (https://api.ruletree.club/typechoUsers/userRegister)
14. SendCode
接口路径:GET/POST /typechoUsers/SendCode
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:登陆后操作的邮箱验证
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.SendCode() (https://api.ruletree.club/typechoUsers/SendCode)
15. RegSendCode
接口路径:GET/POST /typechoUsers/RegSendCode
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:注册邮箱验证
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.RegSendCode() (https://api.ruletree.club/typechoUsers/RegSendCode)
- 前端调用:this.$API.SendCode() (https://api.ruletree.club/typechoUsers/SendCode)
16. sendSMS
接口路径:GET/POST /typechoUsers/sendSMS
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:手机验证
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| phone | String | 否 | - | |
| area | String | 否 | +86 | |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendSMS() (https://api.ruletree.club/typechoUsers/sendSMS)
17. regSendSMS
接口路径:GET/POST /typechoUsers/regSendSMS
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:注册短信验证码发送(场景隔离:存储 sendSMSReg+区号+手机号)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| phone | String | 否 | - | |
| area | String | 否 | +86 | |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendSMS() (https://api.ruletree.club/typechoUsers/sendSMS)
- 前端调用:this.$API.regSendSMS() (https://api.ruletree.club/typechoUsers/regSendSMS)
18. fogetSendSMS
接口路径:GET/POST /typechoUsers/fogetSendSMS
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:找回密码短信验证码发送(场景隔离:存储 sendSMSFoget+区号+手机号)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| phone | String | 否 | - | |
| area | String | 否 | +86 | |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendSMS() (https://api.ruletree.club/typechoUsers/sendSMS)
- 前端调用:this.$API.fogetSendSMS() (https://api.ruletree.club/typechoUsers/fogetSendSMS)
19. userFoget
接口路径:GET/POST /typechoUsers/userFoget
权限:公开接口,不校验 token
接口说明:找回密码(支持 用户名/邮箱 + 邮箱验证码,或 手机号 + 短信验证码) @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userFoget() (https://api.ruletree.club/typechoUsers/userFoget)
20. setClientId
接口路径:GET/POST /typechoUsers/setClientId
权限:需要登录(普通用户及以上)
接口说明:用户clientId修改,用于推送
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| clientId | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.setClientId() (https://api.ruletree.club/typechoUsers/setClientId)
21. userEdit
接口路径:GET/POST /typechoUsers/userEdit
权限:需要登录(普通用户及以上)
接口说明:用户修改 @param params Bean对象JSON字符串
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userEdit() (https://api.ruletree.club/typechoUsers/userEdit)
22. manageUserEdit
接口路径:GET/POST /typechoUsers/manageUserEdit
权限:需要管理员或编辑权限
接口说明:用户修改(管理员)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| uid | Integer | 否 | - | |
| screenName | String | 否 | - | |
| group | String | 否 | - | |
| assets | String | 否 | - | |
| exp | String | 否 | - | |
| experience | String | 否 | - | |
| String | 否 | - | ||
| phone | String | 否 | - | |
| introduce | String | 否 | - | |
| password | String | 否 | - | |
| customize | String | 否 | - | |
| webkey | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userEdit() (https://api.ruletree.club/typechoUsers/userEdit)
- 前端调用:this.$API.manageUserEdit() (https://api.ruletree.club/typechoUsers/manageUserEdit)
23. manageUserAdd
接口路径:GET/POST /typechoUsers/manageUserAdd
权限:需要管理员或编辑权限
接口说明:管理员手动添加用户
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
24. userStatus
接口路径:GET/POST /typechoUsers/userStatus
权限:需要登录(普通用户及以上)
接口说明:用户状态检测
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userStatus() (https://api.ruletree.club/typechoUsers/userStatus)
25. userDelete
接口路径:GET/POST /typechoUsers/userDelete
权限:需要超级管理员权限
接口说明:用户删除
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userDelete() (https://api.ruletree.club/typechoUsers/userDelete)
26. banUser
接口路径:GET/POST /typechoUsers/banUser
权限:需要管理员或编辑权限
接口说明:用户封禁 @param uid 用户ID @param day 封禁天数,0为永久封禁
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| uid | Integer | 否 | - | |
| day | Integer | 否 | 0 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.banUser() (https://api.ruletree.club/typechoUsers/banUser)
- 前端调用:this.$API.ban() (https://api.ruletree.club/typechoUserlog/ban)
27. unblockUser
接口路径:GET/POST /typechoUsers/unblockUser
权限:需要管理员或编辑权限
接口说明:用户解封
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| uid | Integer | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.unblockUser() (https://api.ruletree.club/typechoUsers/unblockUser)
28. userWithdraw
接口路径:GET/POST /typechoUsers/userWithdraw
权限:需要登录(普通用户及以上)
接口说明:用户解封
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| num | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userWithdraw() (https://api.ruletree.club/typechoUsers/userWithdraw)
29. withdrawList
接口路径:GET/POST /typechoUsers/withdrawList
权限:需要登录(普通用户及以上)
接口说明:提现列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.withdrawList() (https://api.ruletree.club/typechoUsers/withdrawList)
30. withdrawStatus
接口路径:GET/POST /typechoUsers/withdrawStatus
权限:需要超级管理员权限
接口说明:提现审核
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | Integer | 否 | - | |
| type | Integer | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.withdrawStatus() (https://api.ruletree.club/typechoUsers/withdrawStatus)
31. userRecharge
接口路径:GET/POST /typechoUsers/userRecharge
权限:需要超级管理员权限
接口说明:管理员手动充扣
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| key | Integer | 否 | - | |
| num | Integer | 否 | - | |
| type | Integer | 否 | - | |
| rechargeType | Integer | 否 | 0 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userRecharge() (https://api.ruletree.club/typechoUsers/userRecharge)
32. signOut
接口路径:GET/POST /typechoUsers/signOut
权限:需要登录(普通用户及以上)
接口说明:退出登录
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.signOut() (https://api.ruletree.club/typechoUsers/signOut)
33. getScan
接口路径:GET/POST /typechoUsers/getScan
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:扫码登陆-生成二维码
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| codeContent | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getScan() (https://api.ruletree.club/typechoUsers/getScan)
34. getScanStatus
接口路径:GET/POST /typechoUsers/getScanStatus
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:扫码登陆-获取扫码状态
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| codeContent | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getScan() (https://api.ruletree.club/typechoUsers/getScan)
- 前端调用:this.$API.getScanStatus() (https://api.ruletree.club/typechoUsers/getScanStatus)
35. setScan
接口路径:GET/POST /typechoUsers/setScan
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:扫码登陆-app载入token
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| codeContent | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.setScan() (https://api.ruletree.club/typechoUsers/setScan)
36. regConfig
接口路径:GET/POST /typechoUsers/regConfig
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:注册系统配置信息
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.regConfig() (https://api.ruletree.club/typechoUsers/regConfig)
37. madeInvitation
接口路径:GET/POST /typechoUsers/madeInvitation
权限:需要超级管理员权限
接口说明:创建邀请码
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| num | Integer | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.madeInvitation() (https://api.ruletree.club/typechoUsers/madeInvitation)
38. invitationList
接口路径:GET/POST /typechoUsers/invitationList
权限:需要超级管理员权限
接口说明:邀请码列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.invitationList() (https://api.ruletree.club/typechoUsers/invitationList)
39. invitationExcel
接口路径:GET/POST /typechoUsers/invitationExcel
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:导出邀请码
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.invitationExcel() (https://api.ruletree.club/typechoUsers/invitationExcel)
40. inbox
接口路径:GET/POST /typechoUsers/inbox
权限:需要登录(普通用户及以上)
接口说明:用户收件箱
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| type | String | 否 | comment | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getInbox() (https://api.ruletree.club/typechoUsers/inbox)
41. unreadNum
接口路径:GET/POST /typechoUsers/unreadNum
权限:需要登录(普通用户及以上)
接口说明:获取用户未读消息数量
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.unreadNum() (https://api.ruletree.club/typechoUsers/unreadNum)
42. setRead
接口路径:GET/POST /typechoUsers/setRead
权限:需要登录(普通用户及以上)
接口说明:将所有消息已读
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| type | String | 否 | all |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.setRead() (https://api.ruletree.club/typechoUsers/setRead)
43. sendUser
接口路径:GET/POST /typechoUsers/sendUser
权限:需要超级管理员权限
接口说明:向指定用户发送消息
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| links | String | 否 | - | |
| uid | Integer | 否 | 0 | |
| text | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.sendUser() (https://api.ruletree.club/typechoUsers/sendUser)
44. follow
接口路径:GET/POST /typechoUsers/follow
权限:需要登录(普通用户及以上)
接口说明:关注和取消关注
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| touid | Integer | 否 | 1 | |
| type | Integer | 否 | 1 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.follow() (https://api.ruletree.club/typechoUsers/follow)
45. isFollow
接口路径:GET/POST /typechoUsers/isFollow
权限:需要登录(普通用户及以上)
接口说明:关注状态
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| touid | Integer | 否 | 1 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.follow() (https://api.ruletree.club/typechoUsers/follow)
- 前端调用:this.$API.isFollow() (https://api.ruletree.club/typechoUsers/isFollow)
46. followList
接口路径:GET/POST /typechoUsers/followList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:Ta关注的人
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| uid | Integer | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.follow() (https://api.ruletree.club/typechoUsers/follow)
- 前端调用:this.$API.followList() (https://api.ruletree.club/typechoUsers/followList)
47. fanList
接口路径:GET/POST /typechoUsers/fanList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:关注Ta的人
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| touid | Integer | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.fanList() (https://api.ruletree.club/typechoUsers/fanList)
48. myBanList
接口路径:GET/POST /typechoUsers/myBanList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:我拉黑的人
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.myBanList() (https://api.ruletree.club/typechoUsers/myBanList)
- 前端调用:this.$API.ban() (https://api.ruletree.club/typechoUserlog/ban)
49. sendUser
接口路径:GET/POST /typechoUsers/userBan
权限:需要管理员或编辑权限
接口说明:管理员封禁指定用户(APP管理端专用)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | - | |
| time | Integer | 否 | - | |
| type | String | 否 | - | |
| text | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userBan() (https://api.ruletree.club/typechoUsers/userBan)
- 前端调用:this.$API.ban() (https://api.ruletree.club/typechoUserlog/ban)
50. unblockUserByManager
接口路径:GET/POST /typechoUsers/userUnblock
权限:需要超级管理员权限
接口说明:解封指定用户(APP管理端专用)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userUnblock() (https://api.ruletree.club/typechoUsers/userUnblock)
51. violationList
接口路径:GET/POST /typechoUsers/violationList
权限:公开接口;但当系统配置 isLogin=1 时会强制要求登录
接口说明:封禁记录
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.violationList() (https://api.ruletree.club/typechoUsers/violationList)
52. dataClean
接口路径:GET/POST /typechoUsers/userClean
权限:需要超级管理员权限
接口说明:用户数据清理
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| clean | Integer | 否 | - | |
| token | String | 否 | - | |
| uid | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.userClean() (https://api.ruletree.club/typechoUsers/userClean)
53. restrict
接口路径:GET/POST /typechoUsers/restrict
权限:需要超级管理员权限
接口说明:限制和解除限制(普通功能限制,不记录数据库)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | - | |
| type | Integer | 否 | 0 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.restrict() (https://api.ruletree.club/typechoUsers/restrict)
54. giftVIP
接口路径:GET/POST /typechoUsers/giftVIP
权限:需要超级管理员权限
接口说明:限制和解除限制(普通功能限制,不记录数据库)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| uid | Integer | 否 | - | |
| day | Integer | 否 | 1 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.giftVIP() (https://api.ruletree.club/typechoUsers/giftVIP)
55. selfDelete
接口路径:GET/POST /typechoUsers/selfDelete
权限:需要登录(普通用户及以上)
接口说明:限制和解除限制(普通功能限制,不记录数据库)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.selfDelete() (https://api.ruletree.club/typechoUsers/selfDelete)
56. selfDelete
接口路径:GET/POST /typechoUsers/selfDeleteOk
权限:需要超级管理员权限
接口说明:限制和解除限制(普通功能限制,不记录数据库)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| type | Integer | 否 | - | |
| uid | Integer | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.selfDelete() (https://api.ruletree.club/typechoUsers/selfDelete)
- 前端调用:this.$API.selfDeleteOk() (https://api.ruletree.club/typechoUsers/selfDeleteOk)
57. selfDeleteList
接口路径:GET/POST /typechoUsers/selfDeleteList
权限:需要超级管理员权限
接口说明:限制和解除限制(普通功能限制,不记录数据库)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.selfDelete() (https://api.ruletree.club/typechoUsers/selfDelete)
- 前端调用:this.$API.selfDeleteList() (https://api.ruletree.club/typechoUsers/selfDeleteList)
58. getKaptcha
接口路径:GET/POST /typechoUsers/getKaptcha
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:生成验证码
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getKaptcha() (https://api.ruletree.club/typechoUsers/getKaptcha)
59. verifyKaptcha
接口路径:GET/POST /typechoUsers/verifyKaptcha
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:验证图片验证码
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| code | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
60. getInvitationCode
接口路径:GET/POST /typechoUsers/getInvitationCode
权限:需要登录(普通用户及以上)
接口说明:获取用户邀请码
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getInvitationCode() (https://api.ruletree.club/typechoUsers/getInvitationCode)
61. inviteData
接口路径:GET/POST /typechoUsers/inviteData
权限:需要登录(普通用户及以上)
接口说明:邀请汇总数据(邀请码/邀请人数/被邀请人消费总额/我的返利总额/返利配置)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.inviteData() (https://api.ruletree.club/typechoUsers/inviteData)
62. inviteList
接口路径:GET/POST /typechoUsers/inviteList
权限:需要登录(普通用户及以上)
接口说明:邀请记录列表(分页):被邀请用户 + 消费统计 + 返利
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 10 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.inviteList() (https://api.ruletree.club/typechoUsers/inviteList)
63. inviteConsumeList
接口路径:GET/POST /typechoUsers/inviteConsumeList
权限:需要登录(普通用户及以上)
接口说明:被邀请用户的消费记录(分页)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| invitedUid | Integer | 否 | 0 | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 10 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.inviteConsumeList() (https://api.ruletree.club/typechoUsers/inviteConsumeList)
64. inviteConsumeAllList
接口路径:GET/POST /typechoUsers/inviteConsumeAllList
权限:需要登录(普通用户及以上)
接口说明:全部被邀请用户的消费记录(分页)
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 10 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.inviteConsumeAllList() (https://api.ruletree.club/typechoUsers/inviteConsumeAllList)
65. report
接口路径:GET/POST /typechoUsers/report
权限:需要登录(普通用户及以上)
接口说明:提交举报信息
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| token | String | 否 | - | |
| text | String | 否 | - | |
| verifyCode | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.report() (https://api.ruletree.club/typechoUsers/report)
66. reportList
接口路径:GET/POST /typechoUsers/reportList
权限:需要管理员或编辑权限
接口说明:举报列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| page | Integer | 否 | 1 | |
| type | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.report() (https://api.ruletree.club/typechoUsers/report)
- 前端调用:this.$API.reportList() (https://api.ruletree.club/typechoUsers/reportList)
67. reportAudit
接口路径:GET/POST /typechoUsers/reportAudit
权限:需要管理员或编辑权限
接口说明:举报审核
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | Integer | 否 | - | |
| token | String | 否 | - | |
| type | Integer | 否 | 1 | |
| remarks | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.report() (https://api.ruletree.club/typechoUsers/report)
- 前端调用:this.$API.reportAudit() (https://api.ruletree.club/typechoUsers/reportAudit)
68. getLocal
接口路径:GET/POST /typechoUsers/getLocal
权限:公开接口,不校验 token
接口说明:获取当前位置
请求参数:
无请求参数
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getLocal() (https://api.ruletree.club/typechoUsers/getLocal)
69. addAddress
接口路径:GET/POST /typechoUsers/addAddress
权限:需要登录(普通用户及以上)
接口说明:添加地址
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - | |
| isDefault | Integer | 否 | 0 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.addAddress() (https://api.ruletree.club/typechoUsers/addAddress)
70. updateAddress
接口路径:GET/POST /typechoUsers/updateAddress
权限:需要登录(普通用户及以上)
接口说明:修改地址
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| params | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| token | String | 否 | - | |
| isDefault | Integer | 否 | 0 |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.updateAddress() (https://api.ruletree.club/typechoUsers/updateAddress)
71. deleteAddress
接口路径:GET/POST /typechoUsers/deleteAddress
权限:需要登录(普通用户及以上)
接口说明:删除地址
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | String | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.deleteAddress() (https://api.ruletree.club/typechoUsers/deleteAddress)
72. addressInfo
接口路径:GET/POST /typechoUsers/addressInfo
权限:需要登录(普通用户及以上)
接口说明:地址详情
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| id | Integer | 否 | - | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.addressInfo() (https://api.ruletree.club/typechoUsers/addressInfo)
73. myAddressList
接口路径:GET/POST /typechoUsers/myAddressList
权限:需要登录(普通用户及以上)
接口说明:查询地址列表
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| searchParams | String(JSON 字符串,需后端解析) | 否 | - | JSON 字符串,需后端解析 |
| page | Integer | 否 | 1 | |
| limit | Integer | 否 | 15 | |
| token | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.myAddressList() (https://api.ruletree.club/typechoUsers/myAddressList)
74. miniOpenid
接口路径:GET/POST /typechoUsers/miniOpenid
权限:未标注(按代码逻辑,通常需登录或走其它校验)
接口说明:获取微信小程序 openid
请求参数:
| 参数名 | 类型 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
| code | String | 否 | - |
响应说明:
{
"code": 1,
"msg": "",
"data": ...
}
前端调用参考:
- 前端调用:this.$API.getOpenid() (https://api.ruletree.club/users/miniOpenid)