正在加载…
面向插件开发者、客户端、测试同学与合作方统一展示正式接口、授权模型、多语言示例与联调路径。
建议把接口调研理解为一个业务闭环：先准备 projectKey，再绑定、查询、扣次，最后用后台日志和 smoke 脚本回证。
在项目管理里确认当前插件对应的 projectKey，并区分是时间型还是次数型激活码。
用户首次输入激活码时调用 /api/license/activate，让系统先绑定 machineId。
拿同一组 code + machineId 调用 /api/license/status，确认 expiresAt / remainingCount / valid 等字段。
只有发生真实业务动作时才调用 /api/license/consume，并且推荐始终带上 requestId。
联调时把 requestId、machineId 带到“消费日志”页搜索，核对每次扣次是否正确落库。
本地启动后执行 smoke:license-api，让项目自动走完登录、建项目、生成卡、激活、状态、幂等扣次。
适合按天/月/年计费的授权模式，首次激活后开始计算有效期。
适合浏览器插件、桌面工具等按次数消耗的场景。
同一个服务端可同时给多个产品、插件或客户提供独立授权空间。
正式接口支持 camelCase / snake_case 双写法，便于不同语言和历史客户端接入。
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| projectKey / project_key | string | 否 | 项目标识；不传时默认走 default 项目。 |
| code | string | 是 | 激活码正文。 |
| machineId / machine_id | string | 是 | 设备唯一标识，建议插件本地持久化一个稳定 UUID。 |
| requestId / request_id | string | 仅 consume 推荐 | 请求幂等键；同一 requestId 的 consume 只会成功扣减一次。 |
正式接口会同时返回 camelCase 与 snake_case，便于浏览器插件、桌面端和脚本工具统一接入。
| 字段 | 类型 | 返回时机 | 说明 |
|---|---|---|---|
| success | boolean | 总是返回 | 业务层是否成功。 |
| message | string | 总是返回 | 提示信息或失败原因。 |
| licenseMode / license_mode | TIME | COUNT | null | 按场景返回 | 授权类型。 |
| expiresAt / expires_at | string | null | 时间型常用 | 时间型过期时间。 |
| remainingCount / remaining_count | number | null | 次数型常用 | 次数型剩余次数。 |
| isActivated / is_activated | boolean | null | 按场景返回 | 当前激活码是否已绑定到设备。 |
| valid | boolean | null | 按场景返回 | 当前是否仍有效。 |
| idempotent | boolean | null | consume 常用 | 本次是否命中了 requestId 幂等重放。 |