用户相关

揭阳市榕城区赛搏技术服务工作室 ∙ hwwlyz.com2024/01/02

用户注册(通过卡密)

请求地址

POST-http://api.hwwlyz.com/api/v1/user/register

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
card是string注册使用的卡密(长度不超过 45 位)
password是string用户密码(长度 6-30 位)
timestamp是int64时间戳,秒级(10 位数)
username是string用户名(长度不能超过 20 位)
sign是string签名

响应示例

{
  "code": 0,
  "message": "",
  "data": null
}

响应参数

参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息

用户登录

请求地址

POST-http://api.hwwlyz.com/api/v1/user/login

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
password是string用户密码(长度 6-30 位)
timestamp是int64时间戳,秒级(10 位数)
username是string用户名(长度不能超过 20 位)
sign是string签名

响应示例

{
    "code": 0,
    "message": "",
    "data": {
        "token": "1lb87kk6qyv5e0cy484v5bbkq5e00rdi",
        "expires": "2024-01-13 21:24:16",
        "expiresTs": 1705152256,
        "config": "test",
        "serverTime": 1704199023
    }
}

响应参数

参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息
dataobject请求正确时,若有额外数据要返回,则结果封装在该字段。若无额外数据,则无此字段。
tokenstring本次登录的标识,鉴权用的令牌
expiresstring卡密过期时间,格式化的
expiresTsint64过期时间戳,秒级(10 位数)
configstring用户的配置
serverTimeint64服务器当前时间戳,秒级(10 位数)

用户心跳 💓

接口说明 用于保持登录状态,刷新 token 的有效期,token 在超过 3 分钟(该值可在软件配置页面更改)未收到心跳请求将自动失效。 建议每隔1分钟(也就是token有效期的三分之一)调用一次

请求地址

POST-http://api.hwwlyz.com/api/v1/user/heartbeat

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
timestamp是int64秒级时间戳,10 位的
token是string登录成功后返回的令牌
username是string用户名(长度不能超过 20 位)
sign是string签名

响应示例

{
    "code": 0,
    "message": "",
    "data": {
        "expires": "2024-01-13 21:24:16",
        "expiresTs": 1705152256,
        "serverTime": 1704199076
    }
}

响应参数

参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息
dataobject请求正确时,若有额外数据要返回,则结果封装在该字段。若无额外数据,则无此字段。
expiresstring卡密过期时间,格式化的
expiresTsint64过期时间戳,秒级,10 位的
serverTimeint64服务器当前时间戳,秒级,10 位的

用户退出登录

请求地址

POST-http://api.hwwlyz.com/api/v1/user/heartbeatLogout

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
timestamp是int64秒级时间戳,10 位的
token是string登录成功后返回的令牌
username是string用户名(长度不能超过 20 位)
sign是string签名

响应示例

{
  "code": 0,
  "message": "",
  "data": null
}

响应参数

参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息

用户修改新密码

请求地址

POST-http://api.hwwlyz.com/api/v1/user/setPassword

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
newPassword是string新密码(长度 6-30 位)
password是string用户当前密码(长度 6-30 位)
timestamp是int64时间戳,秒级(10 位数)
username是string用户名(长度不能超过 20 位)
sign是string签名

响应示例

{
  "code": 0,
  "message": "",
  "data": null
}

响应参数

参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息

用户充值(通过卡密)

请求地址

POST-http://api.hwwlyz.com/api/v1/user/recharge

请求参数

参数名是否必需类型参数说明
appKey是string软件的 appKey
card是string充值使用的卡密(长度不超过 45 位)
timestamp是int64时间戳,秒级(10 位数)
username是string用户名
sign是string签名

响应示例

{
  "code": 0,
  "message": "",
  "data": null
}
参数名类型参数说明
codeint返回码,0 表示正确,详细参照返回码对照表
messagestring请求出错时的错误信息

Last Updated 2024/8/21 00:15:07
评论
  • 按正序
  • 按倒序
  • 按热度
Powered by Waline v2.14.7