# 用户相关
# 用户注册(通过卡密)
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/register
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
card | 是 | string | 登录的卡密 |
device_id | 是 | string | 用户的设备唯一标识码 |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
password | 是 | string | 用户密码(长度 6-30 位) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
username | 是 | int64 | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok"
}
1
2
3
4
2
3
4
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
# 用户登录
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/login
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
device_id | 是 | string | 用户的设备唯一标识码 |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
password | 是 | string | 用户密码(长度 6-30 位) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
username | 是 | int64 | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok",
"result": {
"card_type": "年卡",
"token": "fsTnQHJzuxV5bsUSAK2Q",
"expires": "2020-10-16 00:47:58",
"expires_ts": 1602780478,
"config": "",
"server_time": 1574654197
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
result | object | 请求正确时,若有额外数据要返回,则结果封装在该字段。若无额外数据,则无此字段。 |
cardType | string | 卡密类型 |
token | string | 本次登录的标识,鉴权用的令牌 |
expires | string | 卡密过期时间,格式化的 |
expires_ts | int64 | 过期时间戳,秒级(10位数) |
config | string | 卡密的配置 |
serverTime | int64 | 服务器当前时间戳,秒级(10位数) |
# 用户心跳
接口说明
用于保持登录状态,刷新token的有效期,token在超过10分钟(该值可在软件配置页面更改)+60s未收到心跳请求将自动失效。
建议每隔10分钟调用一次
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/heartbeat
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
token | 是 | string | 登录成功后返回的令牌 |
username | 是 | string | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok",
"result": {
"expires": "2020-10-16 00:47:58",
"expires_ts": 1602780478,
"server_time": 1574654207
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
result | object | 请求正确时,若有额外数据要返回,则结果封装在该字段。若无额外数据,则无此字段。 |
expires | string | 卡密过期时间,格式化的 |
expires_ts | int64 | 过期时间戳,秒级(10位数) |
serverTime | int64 | 服务器当前时间戳,秒级(10位数) |
# 用户退出登录
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/logout
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
token | 是 | string | 登录成功后返回的令牌 |
username | 是 | string | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok"
}
1
2
3
4
2
3
4
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
# 用户修改密码
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/password
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
newPassword | 是 | string | 新密码(长度 6-30 位) |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
username | 是 | string | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok"
}
1
2
3
4
2
3
4
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
# 用户充值(通过卡密)
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/recharge
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
card | 是 | string | 充值使用的卡密(长度不超过 45 位) |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
username | 是 | string | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok"
}
1
2
3
4
2
3
4
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |
# 用户解绑设备
接口说明
说明请先进入开发者后台软件管理页面,配置软件开启设备绑定且可解除绑定。 没有单独的绑定接口,用户在通过卡密注册时就会绑定设备,另在调用登录接口时若检测到未绑定设备则会自动绑定设备
# 请求地址
POST
-http://api1.7ccccccc.com/v1/user/unbind_device
# 请求参数
参数名 | 是否必须 | 类型 | 参数说明 |
---|---|---|---|
appKey | 是 | string | 软件的appKey |
nonce | 是 | string | 不超过36位的随机字符串(建议用UUID) |
timestamp | 是 | int64 | 时间戳,秒级(10位数) |
username | 是 | string | 用户名(长度不能超过 20 位) |
sign | 是 | string | 签名 |
# 响应示例
{
"code": 0,
"message": "ok"
}
1
2
3
4
2
3
4
# 响应参数
参数名 | 类型 | 参数说明 |
---|---|---|
code | int | 返回码,0表示正确,详细参照返回码对照表 |
message | string | 请求出错时的错误信息 |