首页|接入文档
API v1

卡密模式

卡密模式适合一次性激活型的授权方式。用卡密登录后获得 token,后续通过心跳保活。


POST /api/v1/card/login — 卡密登录

使用卡密登录并获取 token,支持首次激活、设备绑定、多开控制。

请求参数

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

返回数据(result)

字段名类型说明
tokenstring会话令牌,后续心跳/登出需携带
card_typestring卡密类型标识
expiresstring卡密到期时间(格式:YYYY-MM-DD HH:mm:ss
expires_tsnumber卡密到期 Unix 时间戳(秒)
configstring卡密自定义配置数据(可为空)
server_timenumber服务器当前时间戳(秒)
hgnumber建议心跳间隔(秒),等于 tokenExpireMinutes*60/3

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

刷新会话有效期,防止 token 过期。建议按 hg 字段间隔定时调用。

请求参数

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

返回数据(result)

字段名类型说明
expiresstring卡密到期时间
expires_tsnumber卡密到期 Unix 时间戳(秒)
server_timenumber服务器当前时间戳

POST /api/v1/card/logout — 登出

销毁当前会话 token,释放多开名额。成功时 result 字段不存在。

请求参数

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

POST /api/v1/card/recharge — 卡密充值

使用一张未激活卡密(use_card)为已激活卡密(card)延长有效期,充值卡密使用后状态变为 expired

请求参数

参数名类型必填说明
app_keystring软件 App Key
cardstring被充值的卡密(必须是已激活状态)
use_cardstring用于充值的卡密(必须是未激活状态)
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

POST /api/v1/card/unbind_device — 解绑设备

将指定设备从卡密的绑定设备列表中移除,需软件开启"允许解绑"功能,且当前 token 有效。

请求参数

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

GET /api/v1/card/config — 获取卡密配置

获取卡密的自定义配置数据(Query 参数)。

请求参数(Query)

参数名类型必填说明
app_keystring软件 App Key
cardstring卡密字符串
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名

返回数据(result)

字段名类型说明
configstring卡密自定义配置内容

POST /api/v1/card/config — 更新卡密配置

更新卡密的自定义配置,内容长度不超过 512 字符。

请求参数

参数名类型必填说明
app_keystring软件 App Key
cardstring卡密字符串
configstring新的配置内容(最大 512 字符)
noncestring随机字符串
timestampnumberUnix 时间戳(秒)
signstring请求签名