luo/one-pipe-system
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
222e5bb11a358dc836d3b34ab9273a8f45d7a228
one-pipe-system/docs/部分API.md
sexygoat 222e5bb11a Initial commit: One Pipe System 
完整的管理系统，包含账户管理、卡片管理、套餐管理、财务管理等功能模块。

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2026-01-22 16:35:33 +08:00

6147 lines
146 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 君鸿卡管系统
## API Docs
- 账号相关 [账号列表](https://po5ylelqjf.apifox.cn/405617122e0.md):
# 账号列表
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts:
get:
summary: 账号列表
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: page
in: query
description: 页码
required: false
schema:
description: 页码
minimum: 1
type: integer
- name: page_size
in: query
description: 每页数量
required: false
schema:
description: 每页数量
maximum: 100
minimum: 1
type: integer
- name: username
in: query
description: 用户名模糊查询
required: false
schema:
description: 用户名模糊查询
maxLength: 50
type: string
- name: phone
in: query
description: 手机号模糊查询
required: false
schema:
description: 手机号模糊查询
maxLength: 20
type: string
- name: user_type
in: query
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
required: false
schema:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
maximum: 4
minimum: 1
type: integer
nullable: true
- name: status
in: query
description: 状态 (0:禁用, 1:启用)
required: false
schema:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountPageResult'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: MOe0zUHskRr3E1mBYpAp3
schemeIds:
- BearerAuth
required: true
use:
id: MOe0zUHskRr3E1mBYpAp3
scopes:
MOe0zUHskRr3E1mBYpAp3:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617122-run
components:
schemas:
ModelAccountPageResult:
properties:
items:
description: 账号列表
items:
$ref: '#/components/schemas/ModelAccountResponse'
type: array
nullable: true
page:
description: 当前页码
type: integer
size:
description: 每页数量
type: integer
total:
description: 总记录数
type: integer
type: object
x-apifox-orders:
- items
- page
- size
- total
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [创建账号](https://po5ylelqjf.apifox.cn/405617123e0.md):
- # 创建账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts:
post:
summary: 创建账号
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelCreateAccountRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: mq7uWvOyAsjtgJF1BxOok
schemeIds:
- BearerAuth
required: true
use:
id: mq7uWvOyAsjtgJF1BxOok
scopes:
mq7uWvOyAsjtgJF1BxOok:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617123-run
components:
schemas:
ModelCreateAccountRequest:
properties:
enterprise_id:
description: 关联企业ID（企业账号必填）
minimum: 0
type: integer
nullable: true
password:
description: 密码
maxLength: 32
minLength: 8
type: string
phone:
description: 手机号
maxLength: 11
minLength: 11
type: string
shop_id:
description: 关联店铺ID（代理账号必填）
minimum: 0
type: integer
nullable: true
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
maximum: 4
minimum: 1
type: integer
username:
description: 用户名
maxLength: 50
minLength: 3
type: string
required:
- password
- phone
- user_type
- username
type: object
x-apifox-orders:
- enterprise_id
- password
- phone
- shop_id
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [移除角色](https://po5ylelqjf.apifox.cn/405617124e0.md):
- # 移除角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{account_id}/roles/{role_id}:
delete:
summary: 移除角色
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: account_id
in: path
description: 账号ID
required: true
example: 0
schema:
description: 账号ID
minimum: 0
type: integer
- name: role_id
in: path
description: 角色ID
required: true
example: 0
schema:
description: 角色ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: M0o8yHs57EEwiWLw7UJIC
schemeIds:
- BearerAuth
required: true
use:
id: M0o8yHs57EEwiWLw7UJIC
scopes:
M0o8yHs57EEwiWLw7UJIC:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617124-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [删除账号](https://po5ylelqjf.apifox.cn/405617125e0.md):
- # 删除账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{id}:
delete:
summary: 删除账号
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: vQKxwiJ7VBUY1pWjlPeOV
schemeIds:
- BearerAuth
required: true
use:
id: vQKxwiJ7VBUY1pWjlPeOV
scopes:
vQKxwiJ7VBUY1pWjlPeOV:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617125-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [获取账号详情](https://po5ylelqjf.apifox.cn/405617126e0.md):
- # 获取账号详情
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{id}:
get:
summary: 获取账号详情
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: M7b0CNlsANQ1hoT-Tq1DO
schemeIds:
- BearerAuth
required: true
use:
id: M7b0CNlsANQ1hoT-Tq1DO
scopes:
M7b0CNlsANQ1hoT-Tq1DO:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617126-run
components:
schemas:
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [更新账号](https://po5ylelqjf.apifox.cn/405617127e0.md):
- # 更新账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{id}:
put:
summary: 更新账号
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdateAccountParams'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: Maf8bOuz_Zul607fLFM1b
schemeIds:
- BearerAuth
required: true
use:
id: Maf8bOuz_Zul607fLFM1b
scopes:
Maf8bOuz_Zul607fLFM1b:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617127-run
components:
schemas:
ModelUpdateAccountParams:
properties:
password:
description: 密码
maxLength: 32
minLength: 8
type: string
nullable: true
phone:
description: 手机号
maxLength: 11
minLength: 11
type: string
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
username:
description: 用户名
maxLength: 50
minLength: 3
type: string
nullable: true
type: object
x-apifox-orders:
- password
- phone
- status
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [获取账号角色](https://po5ylelqjf.apifox.cn/405617128e0.md):
- # 获取账号角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{id}/roles:
get:
summary: 获取账号角色
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ModelRole'
type: array
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: 5k60T_sQuhTeSHocYS2Np
schemeIds:
- BearerAuth
required: true
use:
id: 5k60T_sQuhTeSHocYS2Np
scopes:
5k60T_sQuhTeSHocYS2Np:
BearerAuth: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617128-run
components:
schemas:
ModelRole:
properties:
creator:
minimum: 0
type: integer
role_desc:
type: string
role_name:
type: string
role_type:
type: integer
status:
type: integer
updater:
minimum: 0
type: integer
type: object
x-apifox-orders:
- creator
- role_desc
- role_name
- role_type
- status
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 账号相关 [分配角色](https://po5ylelqjf.apifox.cn/405617129e0.md):
- # 分配角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/accounts/{id}/roles:
post:
summary: 分配角色
deprecated: false
description: ''
tags:
- 账号相关
- 账号相关
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAssignRolesParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security: []
x-apifox-folder: 账号相关
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617129-run
components:
schemas:
ModelAssignRolesParams:
properties:
role_ids:
description: 角色ID列表，传空数组可清空所有角色
items:
minimum: 0
type: integer
type: array
nullable: true
type: object
x-apifox-orders:
- role_ids
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [权限列表](https://po5ylelqjf.apifox.cn/405617130e0.md):
- # 权限列表
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions:
get:
summary: 权限列表
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters:
- name: page
in: query
description: 页码
required: false
schema:
description: 页码
minimum: 1
type: integer
- name: page_size
in: query
description: 每页数量
required: false
schema:
description: 每页数量
maximum: 100
minimum: 1
type: integer
- name: perm_name
in: query
description: 权限名称模糊查询
required: false
schema:
description: 权限名称模糊查询
maxLength: 50
type: string
- name: perm_code
in: query
description: 权限编码模糊查询
required: false
schema:
description: 权限编码模糊查询
maxLength: 100
type: string
- name: perm_type
in: query
description: 权限类型 (1:菜单, 2:按钮)
required: false
schema:
description: 权限类型 (1:菜单, 2:按钮)
maximum: 2
minimum: 1
type: integer
nullable: true
- name: platform
in: query
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
required: false
schema:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
- name: available_for_role_type
in: query
description: 可用角色类型 (1:平台角色, 2:客户角色)
required: false
schema:
description: 可用角色类型 (1:平台角色, 2:客户角色)
maximum: 2
minimum: 1
type: integer
nullable: true
- name: parent_id
in: query
description: 父权限ID
required: false
schema:
description: 父权限ID
minimum: 0
type: integer
nullable: true
- name: status
in: query
description: 状态 (0:禁用, 1:启用)
required: false
schema:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPermissionPageResult'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: bvebuIjOgAiN0c_orPcJu
schemeIds:
- BearerAuth
required: true
use:
id: bvebuIjOgAiN0c_orPcJu
scopes:
bvebuIjOgAiN0c_orPcJu:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617130-run
components:
schemas:
ModelPermissionPageResult:
properties:
items:
description: 权限列表
items:
$ref: '#/components/schemas/ModelPermissionResponse'
type: array
nullable: true
page:
description: 当前页码
type: integer
size:
description: 每页数量
type: integer
total:
description: 总记录数
type: integer
type: object
x-apifox-orders:
- items
- page
- size
- total
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelPermissionResponse:
properties:
available_for_role_types:
description: 可用角色类型 (1:平台角色, 2:客户角色)
type: string
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 权限ID
minimum: 0
type: integer
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
type: string
perm_name:
description: 权限名称
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
sort:
description: 排序值
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
url:
description: 请求路径
type: string
type: object
x-apifox-orders:
- available_for_role_types
- created_at
- creator
- id
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- status
- updated_at
- updater
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [创建权限](https://po5ylelqjf.apifox.cn/405617131e0.md):
- # 创建权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions:
post:
summary: 创建权限
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelCreatePermissionRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPermissionResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: DhXVL84Eawn8bS6b2gO18
schemeIds:
- BearerAuth
required: true
use:
id: DhXVL84Eawn8bS6b2gO18
scopes:
DhXVL84Eawn8bS6b2gO18:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617131-run
components:
schemas:
ModelCreatePermissionRequest:
properties:
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
maxLength: 100
minLength: 1
type: string
perm_name:
description: 权限名称
maxLength: 50
minLength: 1
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
maximum: 2
minimum: 1
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)，默认为 all
type: string
sort:
description: 排序值
minimum: 0
type: integer
url:
description: 请求路径
maxLength: 255
type: string
required:
- perm_code
- perm_name
- perm_type
type: object
x-apifox-orders:
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelPermissionResponse:
properties:
available_for_role_types:
description: 可用角色类型 (1:平台角色, 2:客户角色)
type: string
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 权限ID
minimum: 0
type: integer
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
type: string
perm_name:
description: 权限名称
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
sort:
description: 排序值
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
url:
description: 请求路径
type: string
type: object
x-apifox-orders:
- available_for_role_types
- created_at
- creator
- id
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- status
- updated_at
- updater
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [删除权限](https://po5ylelqjf.apifox.cn/405617132e0.md):
- # 删除权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions/{id}:
delete:
summary: 删除权限
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: tEIGObgpiAkOzPgaklbid
schemeIds:
- BearerAuth
required: true
use:
id: tEIGObgpiAkOzPgaklbid
scopes:
tEIGObgpiAkOzPgaklbid:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617132-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [获取权限详情](https://po5ylelqjf.apifox.cn/405617133e0.md):
- # 获取权限详情
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions/{id}:
get:
summary: 获取权限详情
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPermissionResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: h2jzkxhadb_sk7xuei4aQ
schemeIds:
- BearerAuth
required: true
use:
id: h2jzkxhadb_sk7xuei4aQ
scopes:
h2jzkxhadb_sk7xuei4aQ:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617133-run
components:
schemas:
ModelPermissionResponse:
properties:
available_for_role_types:
description: 可用角色类型 (1:平台角色, 2:客户角色)
type: string
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 权限ID
minimum: 0
type: integer
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
type: string
perm_name:
description: 权限名称
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
sort:
description: 排序值
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
url:
description: 请求路径
type: string
type: object
x-apifox-orders:
- available_for_role_types
- created_at
- creator
- id
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- status
- updated_at
- updater
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [更新权限](https://po5ylelqjf.apifox.cn/405617134e0.md):
- # 更新权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions/{id}:
put:
summary: 更新权限
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdatePermissionParams'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelPermissionResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: 1k4Oc1qkU7rkxab1cqEA4
schemeIds:
- BearerAuth
required: true
use:
id: 1k4Oc1qkU7rkxab1cqEA4
scopes:
1k4Oc1qkU7rkxab1cqEA4:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617134-run
components:
schemas:
ModelUpdatePermissionParams:
properties:
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
maxLength: 100
minLength: 1
type: string
nullable: true
perm_name:
description: 权限名称
maxLength: 50
minLength: 1
type: string
nullable: true
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
nullable: true
sort:
description: 排序值
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
url:
description: 请求路径
maxLength: 255
type: string
nullable: true
type: object
x-apifox-orders:
- parent_id
- perm_code
- perm_name
- platform
- sort
- status
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelPermissionResponse:
properties:
available_for_role_types:
description: 可用角色类型 (1:平台角色, 2:客户角色)
type: string
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 权限ID
minimum: 0
type: integer
parent_id:
description: 父权限ID
minimum: 0
type: integer
nullable: true
perm_code:
description: 权限编码
type: string
perm_name:
description: 权限名称
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
sort:
description: 排序值
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
url:
description: 请求路径
type: string
type: object
x-apifox-orders:
- available_for_role_types
- created_at
- creator
- id
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- status
- updated_at
- updater
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 权限 [获取权限树](https://po5ylelqjf.apifox.cn/405617135e0.md):
- # 获取权限树
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/permissions/tree:
get:
summary: 获取权限树
deprecated: false
description: ''
tags:
- 权限
- 权限
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
items: &ref_1
$ref: '#/components/schemas/ModelPermissionTreeNode'
type: array
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: qFBCGDJXFYZugZ3CX6sn2
schemeIds:
- BearerAuth
required: true
use:
id: qFBCGDJXFYZugZ3CX6sn2
scopes:
qFBCGDJXFYZugZ3CX6sn2:
BearerAuth: []
x-apifox-folder: 权限
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617135-run
components:
schemas:
ModelPermissionTreeNode:
properties:
available_for_role_types:
description: 可用角色类型 (1:平台角色, 2:客户角色)
type: string
children:
description: 子权限列表
items: *ref_1
type: array
id:
description: 权限ID
minimum: 0
type: integer
perm_code:
description: 权限编码
type: string
perm_name:
description: 权限名称
type: string
perm_type:
description: 权限类型 (1:菜单, 2:按钮)
type: integer
platform:
description: 适用端口 (all:全部, web:Web后台, h5:H5端)
type: string
sort:
description: 排序值
type: integer
url:
description: 请求路径
type: string
type: object
x-apifox-orders:
- available_for_role_types
- children
- id
- perm_code
- perm_name
- perm_type
- platform
- sort
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [平台账号列表](https://po5ylelqjf.apifox.cn/405617136e0.md):
- # 平台账号列表
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts:
get:
summary: 平台账号列表
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: page
in: query
description: 页码
required: false
schema:
description: 页码
minimum: 1
type: integer
- name: page_size
in: query
description: 每页数量
required: false
schema:
description: 每页数量
maximum: 100
minimum: 1
type: integer
- name: username
in: query
description: 用户名模糊查询
required: false
schema:
description: 用户名模糊查询
maxLength: 50
type: string
- name: phone
in: query
description: 手机号模糊查询
required: false
schema:
description: 手机号模糊查询
maxLength: 20
type: string
- name: status
in: query
description: 状态 (0:禁用, 1:启用)
required: false
schema:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountPageResult'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: ZDG-aUwNGP25n92JjTf0G
schemeIds:
- BearerAuth
required: true
use:
id: ZDG-aUwNGP25n92JjTf0G
scopes:
ZDG-aUwNGP25n92JjTf0G:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617136-run
components:
schemas:
ModelAccountPageResult:
properties:
items:
description: 账号列表
items:
$ref: '#/components/schemas/ModelAccountResponse'
type: array
nullable: true
page:
description: 当前页码
type: integer
size:
description: 每页数量
type: integer
total:
description: 总记录数
type: integer
type: object
x-apifox-orders:
- items
- page
- size
- total
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [新增平台账号](https://po5ylelqjf.apifox.cn/405617137e0.md):
- # 新增平台账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts:
post:
summary: 新增平台账号
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelCreateAccountRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: E3mcys_qbfV2dZBoRcrBs
schemeIds:
- BearerAuth
required: true
use:
id: E3mcys_qbfV2dZBoRcrBs
scopes:
E3mcys_qbfV2dZBoRcrBs:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617137-run
components:
schemas:
ModelCreateAccountRequest:
properties:
enterprise_id:
description: 关联企业ID（企业账号必填）
minimum: 0
type: integer
nullable: true
password:
description: 密码
maxLength: 32
minLength: 8
type: string
phone:
description: 手机号
maxLength: 11
minLength: 11
type: string
shop_id:
description: 关联店铺ID（代理账号必填）
minimum: 0
type: integer
nullable: true
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
maximum: 4
minimum: 1
type: integer
username:
description: 用户名
maxLength: 50
minLength: 3
type: string
required:
- password
- phone
- user_type
- username
type: object
x-apifox-orders:
- enterprise_id
- password
- phone
- shop_id
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [移除角色](https://po5ylelqjf.apifox.cn/405617138e0.md):
- # 移除角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{account_id}/roles/{role_id}:
delete:
summary: 移除角色
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: account_id
in: path
description: 账号ID
required: true
example: 0
schema:
description: 账号ID
minimum: 0
type: integer
- name: role_id
in: path
description: 角色ID
required: true
example: 0
schema:
description: 角色ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: DgXiGw8SQ5oz2zqJiRpT3
schemeIds:
- BearerAuth
required: true
use:
id: DgXiGw8SQ5oz2zqJiRpT3
scopes:
DgXiGw8SQ5oz2zqJiRpT3:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617138-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [删除平台账号](https://po5ylelqjf.apifox.cn/405617139e0.md):
- # 删除平台账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}:
delete:
summary: 删除平台账号
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: LZEyAbRlJmCyB8FW0Pr9C
schemeIds:
- BearerAuth
required: true
use:
id: LZEyAbRlJmCyB8FW0Pr9C
scopes:
LZEyAbRlJmCyB8FW0Pr9C:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617139-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [获取平台账号详情](https://po5ylelqjf.apifox.cn/405617140e0.md):
- # 获取平台账号详情
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}:
get:
summary: 获取平台账号详情
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: JB1JlADT_kbPfd-dROnI_
schemeIds:
- BearerAuth
required: true
use:
id: JB1JlADT_kbPfd-dROnI_
scopes:
JB1JlADT_kbPfd-dROnI_:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617140-run
components:
schemas:
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [编辑平台账号](https://po5ylelqjf.apifox.cn/405617141e0.md):
- # 编辑平台账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}:
put:
summary: 编辑平台账号
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdateAccountParams'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAccountResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: 3ihLnA7dU1zDQwLRNnTSM
schemeIds:
- BearerAuth
required: true
use:
id: 3ihLnA7dU1zDQwLRNnTSM
scopes:
3ihLnA7dU1zDQwLRNnTSM:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617141-run
components:
schemas:
ModelUpdateAccountParams:
properties:
password:
description: 密码
maxLength: 32
minLength: 8
type: string
nullable: true
phone:
description: 手机号
maxLength: 11
minLength: 11
type: string
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
username:
description: 用户名
maxLength: 50
minLength: 3
type: string
nullable: true
type: object
x-apifox-orders:
- password
- phone
- status
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelAccountResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
enterprise_id:
description: 关联企业ID
minimum: 0
type: integer
nullable: true
id:
description: 账号ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 关联店铺ID
minimum: 0
type: integer
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- created_at
- creator
- enterprise_id
- id
- phone
- shop_id
- status
- updated_at
- updater
- user_type
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [修改密码](https://po5ylelqjf.apifox.cn/405617142e0.md):
- # 修改密码
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}/password:
put:
summary: 修改密码
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdatePasswordParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: Wyeb2Y7HlxSSyYCxuJnO-
schemeIds:
- BearerAuth
required: true
use:
id: Wyeb2Y7HlxSSyYCxuJnO-
scopes:
Wyeb2Y7HlxSSyYCxuJnO-:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617142-run
components:
schemas:
ModelUpdatePasswordParams:
properties:
new_password:
description: 新密码（8-32位）
maxLength: 32
minLength: 8
type: string
required:
- new_password
type: object
x-apifox-orders:
- new_password
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [获取账号角色](https://po5ylelqjf.apifox.cn/405617143e0.md):
- # 获取账号角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}/roles:
get:
summary: 获取账号角色
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ModelRole'
type: array
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: tC47BwRl0JggKXCITMZtU
schemeIds:
- BearerAuth
required: true
use:
id: tC47BwRl0JggKXCITMZtU
scopes:
tC47BwRl0JggKXCITMZtU:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617143-run
components:
schemas:
ModelRole:
properties:
creator:
minimum: 0
type: integer
role_desc:
type: string
role_name:
type: string
role_type:
type: integer
status:
type: integer
updater:
minimum: 0
type: integer
type: object
x-apifox-orders:
- creator
- role_desc
- role_name
- role_type
- status
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [分配角色](https://po5ylelqjf.apifox.cn/405617144e0.md):
- # 分配角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}/roles:
post:
summary: 分配角色
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAssignRolesParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: RZYGa_GLwl2Oscga5pMy7
schemeIds:
- BearerAuth
required: true
use:
id: RZYGa_GLwl2Oscga5pMy7
scopes:
RZYGa_GLwl2Oscga5pMy7:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617144-run
components:
schemas:
ModelAssignRolesParams:
properties:
role_ids:
description: 角色ID列表，传空数组可清空所有角色
items:
minimum: 0
type: integer
type: array
nullable: true
type: object
x-apifox-orders:
- role_ids
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 平台账号 [启用/禁用账号](https://po5ylelqjf.apifox.cn/405617145e0.md):
- # 启用/禁用账号
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/platform-accounts/{id}/status:
put:
summary: 启用/禁用账号
deprecated: false
description: ''
tags:
- 平台账号
- 平台账号
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdateStatusParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: cF_9mxHSdxeVw94pq2GKl
schemeIds:
- BearerAuth
required: true
use:
id: cF_9mxHSdxeVw94pq2GKl
scopes:
cF_9mxHSdxeVw94pq2GKl:
BearerAuth: []
x-apifox-folder: 平台账号
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617145-run
components:
schemas:
ModelUpdateStatusParams:
properties:
status:
description: 状态（0:禁用，1:启用）
maximum: 1
minimum: 0
type: integer
required:
- status
type: object
x-apifox-orders:
- status
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [角色列表](https://po5ylelqjf.apifox.cn/405617146e0.md):
- # 角色列表
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles:
get:
summary: 角色列表
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: page
in: query
description: 页码
required: false
schema:
description: 页码
minimum: 1
type: integer
- name: page_size
in: query
description: 每页数量
required: false
schema:
description: 每页数量
maximum: 100
minimum: 1
type: integer
- name: role_name
in: query
description: 角色名称模糊查询
required: false
schema:
description: 角色名称模糊查询
maxLength: 50
type: string
- name: role_type
in: query
description: 角色类型 (1:平台角色, 2:客户角色)
required: false
schema:
description: 角色类型 (1:平台角色, 2:客户角色)
maximum: 2
minimum: 1
type: integer
nullable: true
- name: status
in: query
description: 状态 (0:禁用, 1:启用)
required: false
schema:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRolePageResult'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: zkt36RrpX4Kf50YbpF52h
schemeIds:
- BearerAuth
required: true
use:
id: zkt36RrpX4Kf50YbpF52h
scopes:
zkt36RrpX4Kf50YbpF52h:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617146-run
components:
schemas:
ModelRolePageResult:
properties:
items:
description: 角色列表
items:
$ref: '#/components/schemas/ModelRoleResponse'
type: array
nullable: true
page:
description: 当前页码
type: integer
size:
description: 每页数量
type: integer
total:
description: 总记录数
type: integer
type: object
x-apifox-orders:
- items
- page
- size
- total
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelRoleResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 角色ID
minimum: 0
type: integer
role_desc:
description: 角色描述
type: string
role_name:
description: 角色名称
type: string
role_type:
description: 角色类型 (1:平台角色, 2:客户角色)
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
type: object
x-apifox-orders:
- created_at
- creator
- id
- role_desc
- role_name
- role_type
- status
- updated_at
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [创建角色](https://po5ylelqjf.apifox.cn/405617147e0.md):
- # 创建角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles:
post:
summary: 创建角色
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelCreateRoleRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRoleResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: pYhxsrW_AdSEKrfF4nOkg
schemeIds:
- BearerAuth
required: true
use:
id: pYhxsrW_AdSEKrfF4nOkg
scopes:
pYhxsrW_AdSEKrfF4nOkg:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617147-run
components:
schemas:
ModelCreateRoleRequest:
properties:
role_desc:
description: 角色描述
maxLength: 255
type: string
role_name:
description: 角色名称
maxLength: 50
minLength: 1
type: string
role_type:
description: 角色类型 (1:平台角色, 2:客户角色)
maximum: 2
minimum: 1
type: integer
required:
- role_name
- role_type
type: object
x-apifox-orders:
- role_desc
- role_name
- role_type
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelRoleResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 角色ID
minimum: 0
type: integer
role_desc:
description: 角色描述
type: string
role_name:
description: 角色名称
type: string
role_type:
description: 角色类型 (1:平台角色, 2:客户角色)
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
type: object
x-apifox-orders:
- created_at
- creator
- id
- role_desc
- role_name
- role_type
- status
- updated_at
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [删除角色](https://po5ylelqjf.apifox.cn/405617148e0.md):
- # 删除角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}:
delete:
summary: 删除角色
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: i3mRoWEoFXbfd7ebmj62O
schemeIds:
- BearerAuth
required: true
use:
id: i3mRoWEoFXbfd7ebmj62O
scopes:
i3mRoWEoFXbfd7ebmj62O:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617148-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [获取角色详情](https://po5ylelqjf.apifox.cn/405617149e0.md):
- # 获取角色详情
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}:
get:
summary: 获取角色详情
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRoleResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: Z5lrTCbptQYTAXgZnhZTQ
schemeIds:
- BearerAuth
required: true
use:
id: Z5lrTCbptQYTAXgZnhZTQ
scopes:
Z5lrTCbptQYTAXgZnhZTQ:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617149-run
components:
schemas:
ModelRoleResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 角色ID
minimum: 0
type: integer
role_desc:
description: 角色描述
type: string
role_name:
description: 角色名称
type: string
role_type:
description: 角色类型 (1:平台角色, 2:客户角色)
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
type: object
x-apifox-orders:
- created_at
- creator
- id
- role_desc
- role_name
- role_type
- status
- updated_at
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [更新角色](https://po5ylelqjf.apifox.cn/405617150e0.md):
- # 更新角色
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}:
put:
summary: 更新角色
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdateRoleParams'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRoleResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: UvKB6j-N9gTZ-8aZZb7tV
schemeIds:
- BearerAuth
required: true
use:
id: UvKB6j-N9gTZ-8aZZb7tV
scopes:
UvKB6j-N9gTZ-8aZZb7tV:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617150-run
components:
schemas:
ModelUpdateRoleParams:
properties:
role_desc:
description: 角色描述
maxLength: 255
type: string
nullable: true
role_name:
description: 角色名称
maxLength: 50
minLength: 1
type: string
nullable: true
status:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
nullable: true
type: object
x-apifox-orders:
- role_desc
- role_name
- status
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelRoleResponse:
properties:
created_at:
description: 创建时间
type: string
creator:
description: 创建人ID
minimum: 0
type: integer
id:
description: 角色ID
minimum: 0
type: integer
role_desc:
description: 角色描述
type: string
role_name:
description: 角色名称
type: string
role_type:
description: 角色类型 (1:平台角色, 2:客户角色)
type: integer
status:
description: 状态 (0:禁用, 1:启用)
type: integer
updated_at:
description: 更新时间
type: string
updater:
description: 更新人ID
minimum: 0
type: integer
type: object
x-apifox-orders:
- created_at
- creator
- id
- role_desc
- role_name
- role_type
- status
- updated_at
- updater
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [获取角色权限](https://po5ylelqjf.apifox.cn/405617151e0.md):
- # 获取角色权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}/permissions:
get:
summary: 获取角色权限
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ModelPermission'
type: array
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: DziiNVm0xJEK_5AhcTdpb
schemeIds:
- BearerAuth
required: true
use:
id: DziiNVm0xJEK_5AhcTdpb
scopes:
DziiNVm0xJEK_5AhcTdpb:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617151-run
components:
schemas:
ModelPermission:
properties:
available_for_role_types:
type: string
creator:
minimum: 0
type: integer
parent_id:
minimum: 0
type: integer
nullable: true
perm_code:
type: string
perm_name:
type: string
perm_type:
type: integer
platform:
type: string
sort:
type: integer
status:
type: integer
updater:
minimum: 0
type: integer
url:
type: string
type: object
x-apifox-orders:
- available_for_role_types
- creator
- parent_id
- perm_code
- perm_name
- perm_type
- platform
- sort
- status
- updater
- url
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [分配权限](https://po5ylelqjf.apifox.cn/405617152e0.md):
- # 分配权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}/permissions:
post:
summary: 分配权限
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelAssignPermissionsParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: zdpJv5RTHDlj4UZZA99RC
schemeIds:
- BearerAuth
required: true
use:
id: zdpJv5RTHDlj4UZZA99RC
scopes:
zdpJv5RTHDlj4UZZA99RC:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617152-run
components:
schemas:
ModelAssignPermissionsParams:
properties:
perm_ids:
description: 权限ID列表
items:
minimum: 0
type: integer
minItems: 1
type: array
nullable: true
required:
- perm_ids
type: object
x-apifox-orders:
- perm_ids
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [更新角色状态](https://po5ylelqjf.apifox.cn/405617153e0.md):
- # 更新角色状态
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{id}/status:
put:
summary: 更新角色状态
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: id
in: path
description: ID
required: true
example: 0
schema:
description: ID
minimum: 0
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUpdateRoleStatusParams'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: T2mVjxdJ2_mcxFBb63jGT
schemeIds:
- BearerAuth
required: true
use:
id: T2mVjxdJ2_mcxFBb63jGT
scopes:
T2mVjxdJ2_mcxFBb63jGT:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617153-run
components:
schemas:
ModelUpdateRoleStatusParams:
properties:
status:
description: 状态 (0:禁用, 1:启用)
maximum: 1
minimum: 0
type: integer
required:
- status
type: object
x-apifox-orders:
- status
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 角色 [移除权限](https://po5ylelqjf.apifox.cn/405617154e0.md):
- # 移除权限
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/roles/{role_id}/permissions/{perm_id}:
delete:
summary: 移除权限
deprecated: false
description: ''
tags:
- 角色
- 角色
parameters:
- name: role_id
in: path
description: 角色ID
required: true
example: 0
schema:
description: 角色ID
minimum: 0
type: integer
- name: perm_id
in: path
description: 权限ID
required: true
example: 0
schema:
description: 权限ID
minimum: 0
type: integer
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: bDZfT_EzTXs2jQvvuUEUs
schemeIds:
- BearerAuth
required: true
use:
id: bDZfT_EzTXs2jQvvuUEUs
scopes:
bDZfT_EzTXs2jQvvuUEUs:
BearerAuth: []
x-apifox-folder: 角色
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405617154-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 认证 [登出](https://po5ylelqjf.apifox.cn/405945913e0.md):
- # 登出
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/logout:
post:
summary: 登出
deprecated: false
description: ''
tags:
- 认证
- 认证
parameters: []
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: Mp7Fy6s8pf7EoY3mfzQI0
schemeIds:
- BearerAuth
required: true
use:
id: Mp7Fy6s8pf7EoY3mfzQI0
scopes:
Mp7Fy6s8pf7EoY3mfzQI0:
BearerAuth: []
x-apifox-folder: 认证
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405945913-run
components:
schemas:
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 认证 [获取当前用户信息](https://po5ylelqjf.apifox.cn/405945914e0.md):
- # 获取当前用户信息
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/me:
get:
summary: 获取当前用户信息
deprecated: false
description: ''
tags:
- 认证
- 认证
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelUserInfo'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: wtls3PvBzeoNtVfpxRxzW
schemeIds:
- BearerAuth
required: true
use:
id: wtls3PvBzeoNtVfpxRxzW
scopes:
wtls3PvBzeoNtVfpxRxzW:
BearerAuth: []
x-apifox-folder: 认证
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405945914-run
components:
schemas:
ModelUserInfo:
properties:
enterprise_id:
description: 企业ID
minimum: 0
type: integer
enterprise_name:
description: 企业名称
type: string
id:
description: 用户ID
minimum: 0
type: integer
phone:
description: 手机号
type: string
shop_id:
description: 店铺ID
minimum: 0
type: integer
shop_name:
description: 店铺名称
type: string
user_type:
description: 用户类型 (1:超级管理员, 2:平台用户, 3:代理账号, 4:企业账号)
type: integer
user_type_name:
description: 用户类型名称
type: string
username:
description: 用户名
type: string
type: object
x-apifox-orders:
- enterprise_id
- enterprise_name
- id
- phone
- shop_id
- shop_name
- user_type
- user_type_name
- username
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 认证 [修改密码](https://po5ylelqjf.apifox.cn/405945915e0.md):
- # 修改密码
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/password:
put:
summary: 修改密码
deprecated: false
description: ''
tags:
- 认证
- 认证
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelChangePasswordRequest'
responses:
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'401':
description: 未认证或认证已过期
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'403':
description: 无权访问
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security:
- BearerAuth: []
x-apifox:
schemeGroups:
- id: v_A4JgKssML1Pl82e76QX
schemeIds:
- BearerAuth
required: true
use:
id: v_A4JgKssML1Pl82e76QX
scopes:
v_A4JgKssML1Pl82e76QX:
BearerAuth: []
x-apifox-folder: 认证
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405945915-run
components:
schemas:
ModelChangePasswordRequest:
properties:
new_password:
type: string
old_password:
type: string
type: object
x-apifox-orders:
- new_password
- old_password
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
- 认证 [刷新 Token](https://po5ylelqjf.apifox.cn/405945916e0.md):
- # 刷新 Token
## OpenAPI Specification
```yaml
openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/api/admin/refresh-token:
post:
summary: 刷新 Token
deprecated: false
description: ''
tags:
- 认证
- 认证
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRefreshTokenRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModelRefreshTokenResponse'
headers: {}
x-apifox-name: ''
'400':
description: 请求参数错误
content:
application/json:
schema: &ref_0
$ref: '#/components/schemas/ErrorResponse'
headers: {}
x-apifox-name: ''
'500':
description: 服务器内部错误
content:
application/json:
schema: *ref_0
headers: {}
x-apifox-name: ''
security: []
x-apifox-folder: 认证
x-apifox-status: released
x-run-in-apifox: https://app.apifox.com/web/project/7591618/apis/api-405945916-run
components:
schemas:
ModelRefreshTokenRequest:
properties:
refresh_token:
type: string
type: object
x-apifox-orders:
- refresh_token
x-apifox-ignore-properties: []
x-apifox-folder: ''
ModelRefreshTokenResponse:
properties:
access_token:
type: string
expires_in:
type: integer
type: object
x-apifox-orders:
- access_token
- expires_in
x-apifox-ignore-properties: []
x-apifox-folder: ''
ErrorResponse:
properties:
code:
description: 错误码
type: integer
message:
description: 错误消息
type: string
timestamp:
description: 时间戳
format: date-time
type: string
required:
- code
- message
- timestamp
type: object
x-apifox-orders:
- code
- message
- timestamp
x-apifox-ignore-properties: []
x-apifox-folder: ''
securitySchemes:
BearerAuth:
bearerFormat: JWT
scheme: bearer
type: jwt
servers:
- url: https://cmp-api.boss160.cn
description: 测试环境
security: []
```
Reference in New Issue View Git Blame Copy Permalink