接口文档
接口列表(占位数据)
单码卡密登录
POST用于单码卡密模式下的首次登录与设备绑定验证。
/index.php?r=conncet| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| app_id | string | 是 | 应用标识 |
| card_key | string | 是 | 卡密内容 |
| device_id | string | 是 | 设备指纹 |
{"code":200,"message":"success","data":{"session_token":"demo_token","expired_at":"2026-12-31 23:59:59"}}
标准 API 登录
POST标准化登录入口,支持用户模式与卡密模式参数扩展。
/index.php?r=api/v1/login| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| username | string | 否 | 用户名 |
| password | string | 否 | 密码摘要 |
| card_key | string | 否 | 卡密 |
{"code":200,"message":"success","data":{"uid":"u1001","token":"demo_token","scope":["auth","ping"]}}
心跳验证
POST用于会话保活和授权状态确认,建议按固定周期调用。
/index.php?r=api/v1/ping| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| token | string | 是 | 登录会话令牌 |
| timestamp | int | 是 | 时间戳 |
| sign | string | 是 | 签名 |
{"code":200,"message":"alive","data":{"remain_seconds":3600}}
查询卡密
POST查询卡密授权状态、过期时间和绑定设备信息。
/index.php?r=api/v1/key/query| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| card_key | string | 是 | 卡密 |
| app_id | string | 是 | 应用标识 |
| sign | string | 是 | 签名 |
{"code":200,"message":"success","data":{"status":"active","bind_device":"machine-001"}}
解绑设备
POST在满足策略条件时,解除卡密与当前设备的绑定关系。
/index.php?r=api/v1/key/unbind| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| card_key | string | 是 | 卡密 |
| device_id | string | 是 | 设备指纹 |
| reason | string | 否 | 解绑原因 |
{"code":200,"message":"unbind success","data":{"unbind_count_left":2}}
获取公告
POST读取平台公告内容,可用于客户端启动提示。
/index.php?r=api/v1/notice| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| app_id | string | 是 | 应用标识 |
| locale | string | 否 | 语言地区 |
| sign | string | 是 | 签名 |
{"code":200,"message":"success","data":{"title":"维护通知","content":"占位公告内容"}}
检查版本更新
POST检测客户端版本并返回更新策略与下载地址。
/index.php?r=api/v1/update| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| version | string | 是 | 当前版本 |
| platform | string | 是 | 平台标识 |
| channel | string | 否 | 发布渠道 |
{"code":200,"message":"success","data":{"latest":"1.1.0","force":false,"url":"https://example.com"}}
获取远程变量
POST拉取服务端下发的配置变量,支持按键查询。
/index.php?r=api/v1/variable| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| keys | array | 否 | 变量键列表 |
| app_id | string | 是 | 应用标识 |
| sign | string | 是 | 签名 |
{"code":200,"message":"success","data":{"switch_login":"on","welcome_text":"hello"}}
当前页面没有匹配的内容,请更换关键词。