# 卡密相关

# 卡密登录

# 请求地址

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

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的app_key
card string 登录的卡密
device_id string 用户的设备唯一标识码
nonce string 不超过36位的随机字符串(建议用UUID)详细解释
timestamp int64 时间戳,秒级(10位数)
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

# 响应参数

参数名 类型 参数说明
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/card/heartbeat

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的app_key
card string 登录的卡密
nonce string 不超过36位的随机字符串(建议用UUID)详细解释
timestamp int64 秒级时间戳,10位的
token string 登录成功后返回的令牌
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

# 响应参数

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

# 卡密退出登录

# 请求地址

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

# 请求参数

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

# 响应示例

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

# 响应参数

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

# 卡密解绑设备

说明

请先进入开发者后台软件管理页面,配置软件开启设备绑定且可解除绑定。

# 请求地址

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

# 请求参数

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

# 响应示例

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

# 响应参数

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

# 卡密设置解绑密码

说明

请先进入开发者后台软件管理页面,配置软件开启设备绑定且可解除绑定。
该密码用于绑定设备丢失或者其它原因导致无法在老设备登录时解绑设备。

# 请求地址

POST-https://api.paojiaoyun.com/v1/card/unbind_password

# 请求参数

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

# 响应示例

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

# 响应参数

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

# 卡密通过密码解绑设备

说明

请先进入开发者后台软件管理页面,配置软件开启设备绑定且可解除绑定。
该接口用于绑定设备丢失或者其它原因导致无法在老设备登录时,通过解绑密码解绑设备。

# 请求地址

POST-https://api.paojiaoyun.com/v1/card/unbind_device/by_password

# 请求参数

参数名 是否必需 类型 参数说明
app_key string 软件的app_key
card string 登录的卡密
nonce string 不超过36位的随机字符串(建议用UUID)详细解释
password string 解绑密码,6-10位
timestamp int64 秒级时间戳,10位的
sign string 签名

# 响应示例

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

# 响应参数

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