首页|接入文档
API v1

用户模式

用户模式适合需要账号体系的软件,终端用户通过用户名密码登录,管理员在控制台管理用户账号和到期时间。


POST /api/v1/user/register — 用户注册

创建新的终端用户账号,密码长度不少于 6 位。

请求参数

参数名类型必填说明
app_keystring软件 App Key
usernamestring用户名
passwordstring密码(不少于 6 位)
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
usernamestring注册成功的用户名

POST /api/v1/user/login — 用户登录

使用用户名/密码登录,返回 token 及到期时间。

请求参数

参数名类型必填说明
app_keystring软件 App Key
usernamestring用户名
passwordstring登录密码
device_idstring设备唯一标识(用于设备绑定)
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
tokenstring会话令牌
usernamestring用户名
expiresAtnumber | null账号到期 Unix 时间戳,永久有效时为 null
configstring用户或软件的自定义配置数据

POST /api/v1/user/heartbeat — 保活心跳

刷新用户会话有效期。

请求参数

参数名类型必填说明
app_keystring软件 App Key
tokenstring登录获取的会话令牌
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
expiresAtnumber新的会话到期 Unix 时间戳

POST /api/v1/user/logout — 用户登出

销毁用户会话 token。成功时 result 字段不存在。

请求参数

参数名类型必填说明
app_keystring软件 App Key
tokenstring登录获取的会话令牌
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名