# 用户相关

# 用户注册(通过卡密)

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/register

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
card string 注册使用的卡密(长度不超过 45 位)
device_id string 用户的设备唯一标识码
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
password string 用户密码(长度 6-30 位)
timestamp int64 时间戳,秒级(10 位数)
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok"
}
1
2
3
4

# 响应参数

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

# 用户登录

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/login

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
device_id string 用户的设备唯一标识码
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
password string 用户密码(长度 6-30 位)
timestamp int64 时间戳,秒级(10 位数)
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok",
  "result": {
    "card_type": "年卡",
    "token": "1OZjmQVVvGY8n15ISYyM",
    "expires": "2022-10-25 03:00:41",
    "expires_ts": 1666638041,
    "config": "123",
    "server_time": 1574756303
  }
}
1
2
3
4
5
6
7
8
9
10
11
12

# 响应参数

参数名 类型 参数说明
code int 返回码,0 表示正确,详细参照返回码对照表
message string 请求出错时的错误信息
result object 请求正确时,若有额外数据要返回,则结果封装在该字段。若无额外数据,则无此字段。
card_type string 卡密类型
token string 本次登录的标识,鉴权用的令牌
expires string 卡密过期时间,格式化的
expires_ts int64 过期时间戳,秒级(10 位数)
config string 用户的配置
server_time int64 服务器当前时间戳,秒级(10 位数)

# 用户心跳 💓

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

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/heartbeat

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
timestamp int64 秒级时间戳,10 位的
token string 登录成功后返回的令牌
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok",
  "result": {
    "expires": "2022-10-25 03:00:41",
    "expires_ts": 1666638041,
    "server_time": 1574756313
  }
}
1
2
3
4
5
6
7
8
9

# 响应参数

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

# 用户退出登录

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/logout

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
timestamp int64 秒级时间戳,10 位的
token string 登录成功后返回的令牌
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok"
}
1
2
3
4

# 响应参数

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

# 用户修改密码

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/password

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
new_password string 新密码(长度 6-30 位)
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
password string 用户当前密码(长度 6-30 位)
timestamp int64 时间戳,秒级(10 位数)
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok"
}
1
2
3
4

# 响应参数

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

# 用户充值(通过卡密)

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/recharge

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
card string 充值使用的卡密(长度不超过 45 位)
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
timestamp int64 时间戳,秒级(10 位数)
username string 用户名
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok"
}
1
2
3
4

# 响应参数

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

# 用户解绑设备

说明请先进入开发者后台软件管理页面,配置软件开启设备绑定且可解除绑定。
没有单独的绑定接口,用户在通过卡密注册时就会绑定设备,另在调用登录接口时若检测到未绑定设备则会自动绑定设备。 :::

# 请求地址

POST-https://api.paojiaoyun.com/v1/user/unbind_device

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的 app_key
device_id string 用户的设备唯一标识码
nonce string 不超过 36 位的随机字符串(建议用 UUID)详细解释
timestamp int64 秒级时间戳,10 位的
token string 登录成功后返回的令牌
username string 用户名(长度不能超过 20 位)
sign string 签名

# 响应示例

{
  "code": 0,
  "message": "ok"
}
1
2
3
4

# 响应参数

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