Nesp Cloud API

OpenAPI Version: 3.1.0

Description: Nesp Cloud的API接口定义

Version: 1.0.0

Servers

生产环境服务器: 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}

Paths

user

用户管理接口（注册、登录、个人信息、忘记密码、注销、验证密码）

POST `/user/register`

Summary: 注册一个新用户

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "username": "user123",
  "account_type": "integer",
  "account": "user@example.com",
  "verify_type": "integer",
  "verification": "string"
}

Response Body:

Description: 注册成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "string",
    "username": "string",
    "email": "string",
    "avatar": "https://example.com",
    "membership": {
      "level": "string",
      "expire_date": "2026-05-31",
      "benefits": "string"
    }
  }
}

POST `/user/send-verification-code`

Summary: 发送验证码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "account_type": "integer",
  "account": "user@example.com"
}

Response Body:

Description: 发送验证码成功

{
  "code": "000000",
  "message": "success",
  "data": null
}

POST `/user/verify-code`

Summary: 验证验证码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "account_type": "integer",
  "account": "user@example.com",
  "code": "123456"
}

Response Body:

Description: 验证验证码成功

{
  "code": "000000",
  "message": "success",
  "data": null
}

POST `/user/verify-password`

Summary: 验证密码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "account_type": "integer",
  "account": "user@example.com",
  "password": "123456"
}

Response Body:

Description: 验证密码成功

{
  "code": "000000",
  "message": "success",
  "data": null
}

POST `/user/login`

Summary: 用户登录

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "account_type": "integer",
  "account": "user@example.com",
  "verify_type": "integer",
  "verification": "string"
}

Response Body:

Description: 用户登录成功

{
  "token": "string",
  "user": {
    "id": "string",
    "username": "string",
    "email": "string",
    "avatar": "https://example.com",
    "membership": {
      "level": "string",
      "expire_date": "2026-05-31",
      "benefits": "string"
    }
  }
}

GET `/user/profile`

Summary: 获取用户信息

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

Description: 获取用户信息成功

{
  "id": "string",
  "username": "string",
  "email": "string",
  "avatar": "https://example.com",
  "membership": {
    "level": "string",
    "expire_date": "2026-05-31",
    "benefits": "string"
  }
}

PUT `/user/profile`

Summary: 更新用户信息

Request Body:

Required: true

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

Response Body:

Description: 更新用户信息成功

{
  "id": "string",
  "username": "string",
  "email": "string",
  "avatar": "https://example.com",
  "membership": {
    "level": "string",
    "expire_date": "2026-05-31",
    "benefits": "string"
  }
}

POST `/user/forgot-password`

Summary: 忘记密码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

{
  "account_type": "integer",
  "account": "user@example.com"
}

Response Body:

Description: 忘记密码成功

{
  "code": "000000",
  "message": "success",
  "data": null
}

POST `/user/unregister`

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

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

Description: 注销用户成功

{
  "code": "000000",
  "message": "success",
  "data": null
}

app

应用相关接口（启动屏、检查更新、系统消息、发布说明、帮助组、反馈、客户端配置）

GET `/app/splash`

Summary: 获取应用的启动页信息

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

Description: 获取应用的启动页信息成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "url": "https://example.com/splash.png",
    "type": "integer"
  }
}

GET `/app/check-update`

Summary: 检查应用是否有更新

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

{
  "code": "000000",
  "message": "success",
  "data": {
    "status": 1,
    "version_code": 100,
    "version_name": "1.0.0",
    "is_force_update": true,
    "url": "https://example.com/update.apk",
    "length": 1024000,
    "release_note": "New features features and improvements"
  }
}

GET `/app/system-message`

Summary: 获取系统消息

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Query Parameters:

Name	Type	Required	Default	Description	Example
page	integer	false	1	查询的页码号	1
page_size	integer	false	20	查询的每页数量大小	20

Response Body:

{
  "code": "000000",
  "message": "success",
  "data": {
    "total": 1,
    "page_size": 10,
    "page": 1,
    "items": {
      "title": "New features and improvements",
      "content_type": "integer",
      "content": "https://example.com/system-message/new-features.html",
      "js": "console.log(\"The system message has been displayed.\");"
    }
  }
}

GET `/app/release-notes`

Summary: 获取应用的发布说明文档

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Query Parameters:

Name	Type	Required	Default	Description	Example
page	integer	false	1	查询的页码号	1
page_size	integer	false	20	查询的每页数量大小	20

Response Body:

{
  "code": "000000",
  "message": "success",
  "data": {
    "total": 1,
    "page_size": 10,
    "page": 1,
    "items": {
      "version_code": 100,
      "version_name": "1.0.0",
      "note": "New features features and improvements"
    }
  }
}

GET `/app/help/groups`

Summary: 获取应用的帮助组

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Query Parameters:

Name	Type	Required	Default	Description	Example
page	integer	false	1	查询的页码号	1
page_size	integer	false	20	查询的每页数量大小	20

Response Body:

{
  "code": "000000",
  "message": "success",
  "data": {
    "total": 1,
    "page_size": 10,
    "page": 1,
    "items": {
      "id": 1,
      "title": "General Help",
      "items": {
        "content_type": "integer",
        "title": "General Help",
        "content": "https://example.com/help/general-help.html"
      }
    }
  }
}

POST `/app/feedback`

Summary: 提交应用的反馈信息

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: true

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

Response Body:

Description: 提交应用的反馈信息成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "total": 1,
    "page_size": 10,
    "page": 1,
    "items": {
      "id": 1,
      "title": "General Help",
      "items": {
        "content_type": "integer",
        "title": "General Help",
        "content": "https://example.com/help/general-help.html"
      }
    }
  }
}

GET `/app/client-config`

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

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

Description: 获取应用的客户端配置信息成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "display_mode": "integer"
  }
}

client-device

客户端设备管理接口（设备列表、设置主设备、删除设备）

GET `/client-device/devices`

Summary: 获取用户的所有设备

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Response Body:

Description: 获取用户的所有设备成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

PUT `/client-device/{device_id}/main`

Summary: 设置用户的主设备

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Path Parameters:

Name	Type	Required	Default	Description	Example
device_id	-	true	-	设备的ID号	0

Request Body:

Required: true

{
  "is_main": true
}

Response Body:

Description: 设置用户的主设备成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

DELETE `/client-device/{device_id}`

Summary: 删除用户的设备

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Path Parameters:

Name	Type	Required	Default	Description	Example
device_id	-	true	-	设备的ID号	0

Response Body:

Description: 删除用户的设备成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

email

邮箱相关接口（发送验证码邮箱、验证验证码邮箱）

POST `/email/send/verification-code`

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

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: false

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

Response Body:

Description: 发送邮箱验证码成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

POST `/email/verify/verification-code`

Summary: 验证邮箱验证码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: false

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

Response Body:

Description: 验证邮箱验证码成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

sms

短信相关接口（发送验证码短信、验证验证码短信）

POST `/sms/send/verification-code`

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

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: false

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

Response Body:

Description: 发送短信验证码成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

POST `/sms/verify/verification-code`

Summary: 验证短信验证码

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: false

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

Response Body:

Description: 验证短信验证码成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

subscription

订阅相关接口（订阅计划）

POST `/subscription/plan`

Summary: 创建一个订阅计划

Headers:

Name	Type	Required	Default	Description	Example
Accepted-Language	string	true	-	响应的接受的语言	zh-CN, en-US
X-Sys	string	true	-	Client的操作系统名称 Allowed values: Android, Linux, Windows, iOS, macOS	Android
X-Sys-Version-Code	integer	true	-	Client的操作系统版本号	0
X-Sys-Version-Name	string	true	-	Client的操作系统版本名称	1.0.0
X-Sys-Arch	string	true	-	Client的操作系统架构类型	arm64
X-Platform-Name	string	true	-	Client的平台名称类型 Allowed values: Web, Native	Native
X-App-Id	integer	true	-	Client的应用ID号	100
X-App-Version-Name	string	true	-	Client的应用版本名称	1.0.0
X-App-Version-Code	integer	true	-	Client的应用版本号	0
X-Device-Name	string	true	-	Client的设备名称	Jack's iPhone
X-Device-Model	string	true	-	Client的设备型号	iPhone 14 Pro Max
X-Device-Brand	string	true	-	Client的设备品牌	Apple
X-Device-Board	string	true	-	Client的设备主板类型	Apple A15 Bionic
X-Device-Id	string	true	-	Client的设备ID号	1234567890

Request Body:

Required: false

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

Response Body:

Description: 创建订阅计划成功

{
  "code": "000000",
  "message": "success",
  "data": {
    "id": "integer",
    "ipv4": "192.168.0.1",
    "ipv6": "fd00:c2b6:b24b:be67:2827:688d:e6a1:6a3b",
    "name": "My Device",
    "model": "iPhone 14 Pro Max",
    "brand": "Apple",
    "board": "A15 Bionic",
    "system_name": "iOS",
    "system_version_code": "integer",
    "system_version_name": "1.0.0",
    "system_arch": "arm64",
    "is_main": true,
    "last_request_time": "2023-01-01T00:00:00Z",
    "last_request_addr": "China",
    "last_login_time": "2023-01-01T00:00:00Z",
    "last_login_addr": "China"
  }
}

Nesp Cloud API

Servers

Paths

user

POST /user/register

~~POST /user/send-verification-code~~

~~ POST /user/verify-code ~~

POST /user/verify-password

POST /user/login

GET /user/profile

PUT /user/profile

POST /user/forgot-password

POST /user/unregister

app

GET /app/splash

GET /app/check-update

GET /app/system-message

GET /app/release-notes

GET /app/help/groups

POST /app/feedback

GET /app/client-config

client-device

GET /client-device/devices

PUT /client-device/{device_id}/main

DELETE /client-device/{device_id}

email

POST /email/send/verification-code

POST /email/verify/verification-code

sms

POST /sms/send/verification-code

POST /sms/verify/verification-code

subscription

POST /subscription/plan

POST `/user/register`

POST `/user/send-verification-code`

POST `/user/verify-code`

POST `/user/verify-password`

POST `/user/login`

GET `/user/profile`

PUT `/user/profile`

POST `/user/forgot-password`

POST `/user/unregister`

GET `/app/splash`

GET `/app/check-update`

GET `/app/system-message`

GET `/app/release-notes`

GET `/app/help/groups`

POST `/app/feedback`

GET `/app/client-config`

GET `/client-device/devices`

PUT `/client-device/{device_id}/main`

DELETE `/client-device/{device_id}`

POST `/email/send/verification-code`

POST `/email/verify/verification-code`

POST `/sms/send/verification-code`

POST `/sms/verify/verification-code`

POST `/subscription/plan`