外观
用户相关
开发中
用户模块客户端接口当前处于开发阶段,以下为预期接口定义。实际行为可能与文档描述不完全一致,请以后续正式版本为准。
用户模式支持通过用户名 + 密码登录,使用卡密注册和充值。
用户注册
使用卡密注册用户账号。
POST /api/client/v1/user/register
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| app_key | string | 是 | 应用标识 |
| username | string | 是 | 用户名(≤20 位) |
| password | string | 是 | 密码(6-30 位) |
| card | string | 是 | 注册用卡密 |
| device_id | string | 是 | 设备唯一标识 |
| timestamp | int | 是 | 当前时间戳(秒) |
| nonce | string | 是 | 随机字符串 |
| sign | string | 是 | 请求签名 |
相关错误码
| 错误码 | 说明 |
|---|---|
| 10242 | 账号已存在 |
| 10240 | 卡密不存在或已被使用 |
用户登录
用户名密码登录。
POST /api/client/v1/user/login
成功响应
json
{
"code": 0,
"message": "ok",
"result": {
"card_type": "月卡",
"token": "abc123...",
"expires": "2024-12-31 23:59:59",
"expires_ts": 1735689599,
"config": "{}",
"server_time": 1703001600,
"hg": 30
}
}相关错误码
| 错误码 | 说明 |
|---|---|
| 10243 | 用户登录密码错误 |
| 10250 | 用户已到期 |
| 10252 | 用户已被冻结 |
| 10253 | 用户超过多开上限 |
用户心跳
保持用户会话活跃。
POST /api/client/v1/user/heartbeat
成功响应
json
{
"code": 0,
"message": "ok",
"result": {
"expires": "2024-12-31 23:59:59",
"expires_ts": 1735689599,
"server_time": 1703001600
}
}用户退出
主动退出用户会话。
POST /api/client/v1/user/logout
用户充值
使用卡密为用户账号充值续费。
POST /api/client/v1/user/recharge
解绑设备
将用户从指定设备解绑。
POST /api/client/v1/user/unbind-device
获取用户配置
获取用户的自定义配置信息。
GET /api/client/v1/user/config
成功响应
json
{
"code": 0,
"message": "ok",
"result": {
"config": "{}"
}
}修改用户配置
修改用户的自定义配置信息。
POST /api/client/v1/user/config
对应实现
- Handler:
internal/module/user/handler_client.go(开发中) - DTO:
internal/module/user/dto_client.go