Nesp Cloud API 1.0.0

Nesp Cloud的API接口定义

Servers

Description	URL
生产环境服务器	https://api.nesp.com/v1
开发环境服务器	https://localhost:8443/v1
测试环境服务器	https://api-staging.nesp.com/v1
The production API server	https://{username}.gigantic-server.com:{port}/{basePath}

user

POST /user/register

注册一个新用户

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "username": "user123",
    "account_type": 0,
    "account": "string",
    "verify_type": 0,
    "verification": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "username",
        "accountType",
        "account",
        "verifyType",
        "verification"
    ],
    "properties": {
        "username": {
            "type": "string",
            "minLength": 3,
            "maxLength": 20,
            "description": "用户名称，如果为空则会动生成一个随机名称",
            "example": "user123"
        },
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        },
        "verify_type": {
            "$ref": "#/components/schemas/VerifyType"
        },
        "verification": {
            "type": "string",
            "minLength": 6
        }
    }
}

Responses

200 OK400 Bad Request

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "$ref": "#/components/schemas/UserProfile"
                }
            }
        }
    ]
}

Refer to the common response description: BadRequest.

POST /user/send-verification-code

发送验证码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "account_type": 0,
    "account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /user/verify-code

验证验证码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "account_type": 0,
    "account": "string",
    "code": "123456"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        },
        "code": {
            "type": "string",
            "example": "123456"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /user/verify-password

验证密码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "account_type": 0,
    "account": "string",
    "password": "123456"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        },
        "password": {
            "type": "string",
            "example": "123456"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /user/login

用户登录

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "account_type": 0,
    "account": "string",
    "verify_type": 0,
    "verification": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "account_type",
        "account",
        "verify_type",
        "verification"
    ],
    "properties": {
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        },
        "verify_type": {
            "$ref": "#/components/schemas/VerifyType"
        },
        "verification": {
            "type": "string"
        }
    }
}

Responses

200 OK401 Unauthorized

application/json

{
    "token": "string",
    "user": {
        "id": "string",
        "username": "string",
        "email": "string",
        "avatar": "string",
        "membership": {
            "level": "normal",
            "expire_date": "2022-04-13",
            "benefits": [
                "string"
            ]
        }
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "token": {
            "type": "string",
            "description": "JWT token"
        },
        "user": {
            "$ref": "#/components/schemas/UserProfile"
        }
    }
}

Refer to the common response description: Unauthorized.

GET /user/profile

获取用户信息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

{
    "id": "string",
    "username": "string",
    "email": "string",
    "avatar": "string",
    "membership": {
        "level": "normal",
        "expire_date": "2022-04-13",
        "benefits": [
            "string"
        ]
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "username": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "avatar": {
            "type": "string",
            "format": "uri"
        },
        "membership": {
            "$ref": "#/components/schemas/MembershipInfo"
        }
    }
}

PUT /user/profile

更新用户信息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token

Request body

application/json

{
    "username": "string",
    "avatar": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "username": {
            "type": "string"
        },
        "avatar": {
            "type": "string"
        }
    }
}

Responses

200 OK

application/json

{
    "id": "string",
    "username": "string",
    "email": "string",
    "avatar": "string",
    "membership": {
        "level": "normal",
        "expire_date": "2022-04-13",
        "benefits": [
            "string"
        ]
    }
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        },
        "username": {
            "type": "string"
        },
        "email": {
            "type": "string"
        },
        "avatar": {
            "type": "string",
            "format": "uri"
        },
        "membership": {
            "$ref": "#/components/schemas/MembershipInfo"
        }
    }
}

POST /user/forgot-password

忘记密码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "account_type": 0,
    "account": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "account_type": {
            "$ref": "#/components/schemas/AccountType"
        },
        "account": {
            "$ref": "#/components/schemas/Account"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /user/unregister

注销用户，永久删除用户账号和用户数据

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

app

GET /app/splash

获取应用的启动页信息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "url": {
                            "type": "string",
                            "description": "启动屏媒体资源的URL",
                            "example": "https://example.com/splash.png"
                        },
                        "type": {
                            "type": "integer",
                            "description": "启动屏媒体资源的类型，0为图片，1为视频",
                            "example": 0
                        }
                    }
                }
            }
        }
    ]
}

GET /app/check-update

检查应用是否有更新

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "type": "object",
                    "properties": {
                        "status": {
                            "type": "integer",
                            "description": "更新状态，0为无更新，1为有新更新",
                            "example": 1
                        },
                        "version_code": {
                            "type": "integer",
                            "description": "应用的最新版本号",
                            "example": 100
                        },
                        "version_name": {
                            "type": "string",
                            "description": "应用的最新版本名称",
                            "example": "1.0.0"
                        },
                        "is_force_update": {
                            "type": "boolean",
                            "description": "是否强制更新",
                            "example": true
                        },
                        "url": {
                            "type": "string",
                            "description": "最新版本的下载URL",
                            "example": "https://example.com/update.apk"
                        },
                        "length": {
                            "type": "integer",
                            "description": "最新版本文件的大小，单位字节",
                            "example": 1024000
                        },
                        "release_note": {
                            "type": "string",
                            "description": "最新版本的发布说明内容",
                            "example": "New features features and improvements"
                        }
                    }
                }
            }
        }
    ]
}

GET /app/system-message

获取系统消息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`page`	query	integer	1	No	查询的页码号
`page_size`	query	integer	20	No	查询的每页数量大小
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "allOf": [
                        {
                            "$ref": "#/components/schemas/BasePaginationData"
                        },
                        {
                            "type": "object",
                            "properties": {
                                "items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/SystemMessageResponseItem"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

GET /app/release-notes

获取应用的发布说明文档

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`page`	query	integer	1	No	查询的页码号
`page_size`	query	integer	20	No	查询的每页数量大小
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "allOf": [
                        {
                            "$ref": "#/components/schemas/BasePaginationData"
                        },
                        {
                            "type": "object",
                            "properties": {
                                "items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/ReleaseNoteResponseItem"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

GET /app/help/groups

获取应用的帮助组

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`page`	query	integer	1	No	查询的页码号
`page_size`	query	integer	20	No	查询的每页数量大小
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "allOf": [
                        {
                            "$ref": "#/components/schemas/BasePaginationData"
                        },
                        {
                            "type": "object",
                            "properties": {
                                "items": {
                                    "type": "array",
                                    "items": {
                                        "$ref": "#/components/schemas/HelpGroupResponseItem"
                                    }
                                }
                            }
                        }
                    ]
                }
            }
        }
    ]
}

POST /app/feedback

提交应用的反馈信息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "version_code": 100,
    "version_name": "1.0.0",
    "content": "I found a bug",
    "contact_type": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "version_code": {
            "type": "integer",
            "description": "发送反馈的应用的版本号",
            "example": 100
        },
        "version_name": {
            "type": "string",
            "description": "发送反馈的应用的版本名称",
            "example": "1.0.0"
        },
        "content": {
            "type": "string",
            "description": "反馈的内容",
            "example": "I found a bug"
        },
        "contact_type": {
            "type": "integer",
            "description": "联系方式的类型，其值有:\n  0: QQ\n  1: WeChat\n  2: Email",
            "example": 0
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

GET /app/client-config

获取应用的客户端配置信息

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "$ref": "#/components/schemas/ClientConfigResponse"
                }
            }
        }
    ]
}

client-device

GET /client-device/devices

获取用户的所有设备

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "$ref": "#/components/schemas/ClientDevicesResponse"
                }
            }
        }
    ]
}

PUT /client-device/{device_id}/main

设置用户的主设备

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`device_id`	path			No	设备的ID号
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "is_main": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "is_main": {
            "type": "boolean",
            "description": "设备是否为用户的主要设备",
            "example": true
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

DELETE /client-device/{device_id}

删除用户的设备

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`device_id`	path			No	设备的ID号
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

email

POST /email/send/verification-code

发送邮箱验证码到指定邮箱

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "email": "user@example.com",
    "type": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "email",
        "type"
    ],
    "properties": {
        "email": {
            "type": "string",
            "description": "用户的邮箱地址",
            "example": "user@example.com"
        },
        "type": {
            "$ref": "#/components/schemas/VerifyCodeType"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /email/verify/verification-code

验证邮箱验证码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "code": 123456,
    "email": "user@example.com",
    "type": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "code",
        "email",
        "type"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "验证码内容",
            "example": 123456
        },
        "email": {
            "type": "string",
            "description": "用户的邮箱地址",
            "example": "user@example.com"
        },
        "type": {
            "$ref": "#/components/schemas/VerifyCodeType"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

sms

POST /sms/send/verification-code

发送短信验证码到指定手机号

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "phone": 12345678901,
    "type": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "phone",
        "type"
    ],
    "properties": {
        "phone": {
            "type": "string",
            "description": "用户的手机号",
            "example": 12345678901
        },
        "type": {
            "$ref": "#/components/schemas/VerifyCodeType"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

POST /sms/verify/verification-code

验证短信验证码

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "code": 123456,
    "phone": 12345678901,
    "type": 0
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "code",
        "phone",
        "type"
    ],
    "properties": {
        "code": {
            "type": "string",
            "description": "验证码内容",
            "example": 123456
        },
        "phone": {
            "type": "string",
            "description": "用户的手机号",
            "example": 12345678901
        },
        "type": {
            "$ref": "#/components/schemas/VerifyCodeType"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

subscription

POST /subscription/plan

创建一个订阅计划

Input parameters

Parameter	In	Type	Default	Nullable	Description
`BearerAuth`	header	string	N/A	No	JWT Bearer token
`Accepted-Language`	header	string		No	响应的接受的语言
`X-App-Id`	header	integer		No	Client的应用ID号
`X-App-Version-Code`	header	integer		No	Client的应用版本号
`X-App-Version-Name`	header	string		No	Client的应用版本名称
`X-Device-Board`	header	string		No	Client的设备主板类型
`X-Device-Brand`	header	string		No	Client的设备品牌
`X-Device-Id`	header	string		No	Client的设备ID号
`X-Device-Model`	header	string		No	Client的设备型号
`X-Device-Name`	header	string		No	Client的设备名称
`X-Platform-Name`	header	string		No	Client的平台名称类型
`X-Sys`	header	string		No	Client的操作系统名称
`X-Sys-Arch`	header	string		No	Client的操作系统架构类型
`X-Sys-Version-Code`	header	integer		No	Client的操作系统版本号
`X-Sys-Version-Name`	header	string		No	Client的操作系统版本名称

Request body

application/json

{
    "code_type": 1,
    "code": "123456"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "properties": {
        "code_type": {
            "type": "integer",
            "description": "码的类型, 其值有:\n  1: 激活码\n  2: 计划码",
            "example": 1
        },
        "code": {
            "type": "string",
            "description": "码的内容",
            "example": "123456"
        }
    }
}

Responses

200 OK

application/json

Schema of the response body

{
    "allOf": [
        {
            "$ref": "#/components/schemas/BaseResponse"
        },
        {
            "type": "object",
            "properties": {
                "data": {
                    "nullable": true,
                    "example": null
                }
            }
        }
    ]
}

Schemas

Account

Type: string

AccountType

Type: integer

BasePaginationData

Name	Type	Description
`items`	Array<>
`page`	integer	当前页码数
`page_size`	integer	当前页大小
`total`	integer	总页数数量

BaseResponse

Name	Type	Description
`code`	string
`data`		业务数据，可以是任意类型，也可以为空
`message`	string

CheckUpdateResponse

Type:

ClientConfigResponse

Name	Type	Description
`display_mode`	integer	应用的显示模式，其值有: 0: 正常显示 1: 灰度显示

ClientDeviceItemResponse

Name	Type	Description
`board`	string \| null	设备的主板
`brand`	string \| null	设备的品牌
`id`	integer(int32)	设备的ID号
`ipv4`	string(ipv4)	设备的IPv4地址
`ipv6`	string(ipv6) \| null	设备的IPv6地址
`is_main`	boolean	设备是否为用户的主要设备
`last_login_addr`	string \| null	最近的登录地址
`last_login_time`	string(date-time) \| null	最近的登录时间
`last_request_addr`	string	最近的请求地址
`last_request_time`	string(date-time)	最近的请求时间
`model`	string \| null	设备的型号
`name`	string \| null	设备的名称
`system_arch`	string	设备的操作系统架构
`system_name`	string	设备的操作系统名称
`system_version_code`	integer(int32)	设备的操作系统版本号
`system_version_name`	string	设备的操作系统版本名称

ClientDevicesResponse

Type: Array<ClientDeviceItemResponse>

EmailAccount

Type: string(email)

EmptyDataResponse

Type:

FeedbackRequest

Name	Type	Description
`contact_type`	integer	联系方式的类型，其值有: 0: QQ 1: WeChat 2: Email
`content`	string	反馈的内容
`version_code`	integer	发送反馈的应用的版本号
`version_name`	string	发送反馈的应用的版本名称

HelpGroupResponseItem

Name	Type	Description
`id`	integer	帮助组的ID号
`items`	Array<HelpResponseItem>	帮助组中的帮助文章列表
`title`	string	帮助组的标题

HelpResponseItem

Name	Type	Description
`content`	string	帮助文章的内容
`content_type`	TextContentType
`title`	string	帮助文章的标题

LoginRequest

Name	Type	Description
`account`	Account
`account_type`	AccountType
`verification`	string
`verify_type`	VerifyType

LoginResponse

Name	Type	Description
`token`	string	JWT token
`user`	UserProfile

MembershipInfo

Name	Type	Description
`benefits`	Array<string>
`expire_date`	string(date)
`level`	string

PhoneAccount

Type: string(phone)

RegisterRequest

Name	Type	Description
`account`	Account
`account_type`	AccountType
`username`	string	用户名称，如果为空则会动生成一个随机名称
`verification`	string
`verify_type`	VerifyType

ReleaseNoteResponseItem

Name	Type	Description
`note`	string	发行日志对应的应用的发布说明内容
`version_code`	integer	发行日志对应的应用的版本号
`version_name`	string	发行日志对应的应用的版本名称

SendVerificationCodeEmailRequest

Name	Type	Description
`email`	string	用户的邮箱地址
`type`	VerifyCodeType

SendVerificationCodeSmsRequest

Name	Type	Description
`phone`	string	用户的手机号
`type`	VerifyCodeType

SetMainDeviceRequest

Name	Type	Description
`is_main`	boolean	设备是否为用户的主要设备

SplashResponse

Type:

SubscriptionPlanRequest

Name	Type	Description
`code`	string	码的内容
`code_type`	integer	码的类型, 其值有: 1: 激活码 2: 计划码

SystemMessageResponseItem

Name	Type	Description
`content`	string	系统消息的内容
`content_type`	TextContentType
`js`	string \| null	系统消息的JavaScript代码，将在系统消息显示时执行
`title`	string	系统消息的标题

TextContentType

Type: integer

UpdateProfileRequest

Name	Type	Description
`avatar`	string
`username`	string

UserProfile

Name	Type	Description
`avatar`	string(uri)
`email`	string
`id`	string
`membership`	MembershipInfo
`username`	string

VerifyCodeRequest

Name	Type	Description
`code`	string	验证码内容
`email`	string	用户的邮箱地址
`type`	VerifyCodeType

VerifyCodeRequest-2

Name	Type	Description
`code`	string	验证码内容
`phone`	string	用户的手机号
`type`	VerifyCodeType

VerifyCodeType

Type: integer

VerifyType

Type: integer

Common responses

This section describes common responses that are reused across operations.

BadRequest

请求参数错误

application/json

{
    "code": 400,
    "message": "邮箱或手机号已被注册注册"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "example": 400
        },
        "message": {
            "type": "string",
            "example": "邮箱或手机号已被注册注册"
        }
    }
}

Unauthorized

未授权（未登录或 token 失效）

application/json

{
    "code": 401,
    "message": "请先登录"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "code": {
            "type": "integer",
            "example": 401
        },
        "message": {
            "type": "string",
            "example": "请先登录"
        }
    }
}

Common parameters

This section describes common parameters that are reused across operations.

Accepted-Language

Name	In	Type	Default	Nullable	Description
`Accepted-Language`	header	string		No

X-Sys

Name	In	Type	Default	Nullable	Description
`X-Sys`	header	string		No

X-Sys-Version-Code

Name	In	Type	Default	Nullable	Description
`X-Sys-Version-Code`	header	integer		No

X-Sys-Version-Name

Name	In	Type	Default	Nullable	Description
`X-Sys-Version-Name`	header	string		No

X-Sys-Arch

Name	In	Type	Default	Nullable	Description
`X-Sys-Arch`	header	string		No

X-Platform-Name

Name	In	Type	Default	Nullable	Description
`X-Platform-Name`	header	string		No

X-App-Id

Name	In	Type	Default	Nullable	Description
`X-App-Id`	header	integer		No

X-App-Version-Name

Name	In	Type	Default	Nullable	Description
`X-App-Version-Name`	header	string		No

X-App-Version-Code

Name	In	Type	Default	Nullable	Description
`X-App-Version-Code`	header	integer		No

X-Device-Name

Name	In	Type	Default	Nullable	Description
`X-Device-Name`	header	string		No

X-Device-Model

Name	In	Type	Default	Nullable	Description
`X-Device-Model`	header	string		No

X-Device-Brand

Name	In	Type	Default	Nullable	Description
`X-Device-Brand`	header	string		No

X-Device-Board

Name	In	Type	Default	Nullable	Description
`X-Device-Board`	header	string		No

X-Device-Id

Name	In	Type	Default	Nullable	Description
`X-Device-Id`	header	string		No

page

Name	In	Type	Default	Nullable	Description
`page`	query	integer	1	No

pageSize

Name	In	Type	Default	Nullable	Description
`page_size`	query	integer	20	No

DeviceIdParameter

Name	In	Type	Default	Nullable	Description
`device_id`	path	None		No

Security schemes

Name	Type	Scheme	Description
BearerAuth	http	bearer

Name	Description
user	用户管理接口（注册、登录、个人信息、忘记密码、注销、验证密码）
app	应用相关接口（启动屏、检查更新、系统消息、发布说明、帮助组、反馈、客户端配置）
client-device	客户端设备管理接口（设备列表、设置主设备、删除设备）
email	邮箱相关接口（发送验证码邮箱、验证验证码邮箱）
sms	短信相关接口（发送验证码短信、验证验证码短信）
subscription	订阅相关接口（订阅计划）