用户模式
用户模式适合需要账号体系的软件,终端用户通过用户名密码登录,管理员在控制台管理用户账号和到期时间。
POST /api/v1/user/register — 用户注册
创建新的终端用户账号,密码长度不少于 6 位。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
username | string | 是 | 用户名 |
password | string | 是 | 密码(不少于 6 位) |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
username | string | 注册成功的用户名 |
POST /api/v1/user/login — 用户登录
使用用户名/密码登录,返回 token 及到期时间。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
username | string | 是 | 用户名 |
password | string | 是 | 登录密码 |
device_id | string | 否 | 设备唯一标识(用于设备绑定) |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
token | string | 会话令牌 |
username | string | 用户名 |
expiresAt | number | null | 账号到期 Unix 时间戳,永久有效时为 null |
config | string | 用户或软件的自定义配置数据 |
POST /api/v1/user/heartbeat — 保活心跳
刷新用户会话有效期。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
token | string | 是 | 登录获取的会话令牌 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
expiresAt | number | 新的会话到期 Unix 时间戳 |
POST /api/v1/user/logout — 用户登出
销毁用户会话 token。成功时 result 字段不存在。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
token | string | 是 | 登录获取的会话令牌 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |