bytefun/.bytefun/globalApiInterfaceList.md

一个打通了原型设计、UI设计与代码转换、跨平台原生代码开发等的平台

# 32号旅游 - 后端API接口文档

## 账号系统业务模块11

**模块标识**: accountBizModule

**模块描述**: 包括发送短信验证码、手机号登录、手机号注册、注销（退出）、账号密码登录业务服务

### 发送短信验证码

**基本信息**
- **接口名称**: 发送短信验证码
- **接口标识**: sendSmsCode
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/send/code`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| mobile | string | 是 | 手机号 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": "string"
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | string | 响应数据 |

---

### 手机号登录

**基本信息**
- **接口名称**: 手机号登录
- **接口标识**: mobileLogin
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/mobile`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| mobile | string | 是 | 手机号 |
| code | string | 是 | 验证码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "access_token": "string"
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 登录返回数据 |
| data.access_token | string | 访问令牌 |

---

### 手机号注册

**基本信息**
- **接口名称**: 手机号注册
- **接口标识**: mobileSignUp
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/mobile/signUp`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| mobile | string | 是 | 手机号 |
| code | string | 是 | 验证码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "access_token": "string"
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 注册返回数据 |
| data.access_token | string | 访问令牌 |

---

### 注销（退出）

**基本信息**
- **接口名称**: 注销（退出）
- **接口标识**: logout
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/logout`
- **是否需要认证**: 是

**请求头**
```
Content-Type: application/json
```

**请求参数**: 无

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": "string"
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | string | 响应数据 |

---

### 账号密码登录

**基本信息**
- **接口名称**: 账号密码登录
- **接口标识**: login
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/login`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| username | string | 是 | 用户名 |
| password | string | 是 | 密码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "access_token": "string"
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 登录返回数据 |
| data.access_token | string | 访问令牌 |

---

### 重置密码

**基本信息**
- **接口名称**: 重置密码
- **接口标识**: resetPassword
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/reset/password`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| mobile | string | 是 | 手机号 |
| code | string | 是 | 验证码 |
| newPassword | string | 是 | 新密码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": "string"
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | string | 响应数据 |

---

### 修改密码

**基本信息**
- **接口名称**: 修改密码
- **接口标识**: changePassword
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/change/password`
- **是否需要认证**: 是

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| oldPassword | string | 是 | 原密码 |
| newPassword | string | 是 | 新密码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": "string"
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | string | 响应数据 |

---

### 账号注销

**基本信息**
- **接口名称**: 账号注销
- **接口标识**: deleteAccount
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/delete/account`
- **是否需要认证**: 是

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| password | string | 是 | 密码确认 |
| reason | integer | 是 | 注销原因（1=不再使用，2=隐私担忧，3=功能不满意，4=其他） |
| reasonText | string | 否 | 详细原因说明 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": "string"
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | string | 响应数据 |

---

### 获取用户协议

**基本信息**
- **接口名称**: 获取用户协议
- **接口标识**: getUserAgreement
- **请求方法**: GET
- **请求路径**: `/client/biz/agreement/user`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**: 无

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "title": "string",
    "content": "string",
    "version": "string"
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 协议数据 |
| data.title | string | 协议标题 |
| data.content | string | 协议内容 |
| data.version | string | 版本号 |

---

### 获取隐私协议

**基本信息**
- **接口名称**: 获取隐私协议
- **接口标识**: getPrivacyPolicy
- **请求方法**: GET
- **请求路径**: `/client/biz/agreement/privacy`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**: 无

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "title": "string",
    "content": "string",
    "version": "string"
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 协议数据 |
| data.title | string | 协议标题 |
| data.content | string | 协议内容 |
| data.version | string | 版本号 |

---

### 获取帮助文档列表

**基本信息**
- **接口名称**: 获取帮助文档列表
- **接口标识**: getHelpDocuments
- **请求方法**: GET
- **请求路径**: `/client/biz/help/documents`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| categoryId | integer | 否 | 分类ID，不传则获取所有 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "title": "string",
      "content": "string",
      "categoryId": 0
    }
  ]
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | array | 帮助文档列表 |
| data[n].id | integer | 文档ID |
| data[n].title | string | 文档标题 |
| data[n].content | string | 文档内容 |
| data[n].categoryId | integer | 分类ID |

---

### 搜索帮助内容

**基本信息**
- **接口名称**: 搜索帮助内容
- **接口标识**: searchHelpContent
- **请求方法**: GET
- **请求路径**: `/client/biz/help/search`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| keyword | string | 是 | 搜索关键词 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": [
    {
      "id": 0,
      "title": "string",
      "content": "string"
    }
  ]
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | array | 搜索结果列表 |
| data[n].id | integer | 文档ID |
| data[n].title | string | 文档标题 |
| data[n].content | string | 文档内容摘要 |

---

### 第三方登录

**基本信息**
- **接口名称**: 第三方登录
- **接口标识**: thirdPartyLogin
- **请求方法**: POST
- **请求路径**: `/client/biz/auth/third-party/login`
- **是否需要认证**: 否

**请求头**
```
Content-Type: application/json
```

**请求参数**
| 参数名 | 类型 | 必需 | 描述 |
|--------|------|------|------|
| platform | string | 是 | 平台类型（wechat/qq/weibo） |
| code | string | 是 | 第三方平台授权码 |

**响应格式**
```json
{
  "code": 0,
  "msg": "string",
  "data": {
    "access_token": "string",
    "isNewUser": false
  }
}
```

**响应字段说明**
| 字段名 | 类型 | 描述 |
|--------|------|------|
| code | integer | 编码 0表示成功，其他值表示失败 |
| msg | string | 消息内容 |
| data | object | 登录返回数据 |
| data.access_token | string | 访问令牌 |
| data.isNewUser | boolean | 是否为新用户 |

---