卡密模式
卡密模式适合一次性激活型的授权方式。用卡密登录后获得 token,后续通过心跳保活。
POST /api/v1/card/login — 卡密登录
使用卡密登录并获取 token,支持首次激活、设备绑定、多开控制。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
device_id | string | 是 | 设备唯一标识(用于设备绑定) |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
token | string | 会话令牌,后续心跳/登出需携带 |
card_type | string | 卡密类型标识 |
expires | string | 卡密到期时间(格式:YYYY-MM-DD HH:mm:ss) |
expires_ts | number | 卡密到期 Unix 时间戳(秒) |
config | string | 卡密自定义配置数据(可为空) |
server_time | number | 服务器当前时间戳(秒) |
hg | number | 建议心跳间隔(秒),等于 tokenExpireMinutes*60/3 |
POST /api/v1/card/heartbeat — 保活心跳
刷新会话有效期,防止 token 过期。建议按 hg 字段间隔定时调用。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
token | string | 是 | 登录获取的会话令牌 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
expires | string | 卡密到期时间 |
expires_ts | number | 卡密到期 Unix 时间戳(秒) |
server_time | number | 服务器当前时间戳 |
POST /api/v1/card/logout — 登出
销毁当前会话 token,释放多开名额。成功时 result 字段不存在。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
token | string | 是 | 登录获取的会话令牌 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
POST /api/v1/card/recharge — 卡密充值
使用一张未激活卡密(use_card)为已激活卡密(card)延长有效期,充值卡密使用后状态变为 expired。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 被充值的卡密(必须是已激活状态) |
use_card | string | 是 | 用于充值的卡密(必须是未激活状态) |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
POST /api/v1/card/unbind_device — 解绑设备
将指定设备从卡密的绑定设备列表中移除,需软件开启"允许解绑"功能,且当前 token 有效。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
device_id | string | 是 | 要解绑的设备 ID |
token | string | 是 | 登录获取的会话令牌 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
GET /api/v1/card/config — 获取卡密配置
获取卡密的自定义配置数据(Query 参数)。
请求参数(Query)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |
返回数据(result)
| 字段名 | 类型 | 说明 |
|---|---|---|
config | string | 卡密自定义配置内容 |
POST /api/v1/card/config — 更新卡密配置
更新卡密的自定义配置,内容长度不超过 512 字符。
请求参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
app_key | string | 是 | 软件 App Key |
card | string | 是 | 卡密字符串 |
config | string | 是 | 新的配置内容(最大 512 字符) |
nonce | string | 是 | 随机字符串 |
timestamp | number | 是 | Unix 时间戳(秒) |
sign | string | 是 | 请求签名 |