对外接入说明

API 文档

给插件、桌面端与测试同学直接查阅:正式接口、授权模型、多语言示例与联调路径。

项目与发码

联调之前先准备 projectKey 和测试激活码。

  • POST/api/admin/projects

    创建项目,适合为浏览器插件、桌面端或不同客户生成独立 projectKey。

    http://127.0.0.1:3000/api/admin/projects

  • PATCH/api/admin/projects/{id}

    启停项目或修改项目名称、描述。

    http://127.0.0.1:3000/api/admin/projects/{id}

  • POST/api/admin/codes/generate

    为指定项目生成时间型或次数型激活码。

    http://127.0.0.1:3000/api/admin/codes/generate

  • GET/api/admin/codes/list

    按项目、状态、套餐与关键词筛选激活码,支持服务端分页。

    http://127.0.0.1:3000/api/admin/codes/list

  • GET/api/admin/codes/export

    按当前筛选条件导出激活码 CSV。

    http://127.0.0.1:3000/api/admin/codes/export

日志与统计

当插件调用异常时,可反向查消费日志与趋势数据。

  • GET/api/admin/consumptions

    按 projectKey、keyword、createdFrom、createdTo 查询消费日志。

    http://127.0.0.1:3000/api/admin/consumptions

  • GET/api/admin/consumptions/export

    按当前筛选条件导出消费日志 CSV。

    http://127.0.0.1:3000/api/admin/consumptions/export

  • GET/api/admin/consumptions/trend

    获取最近 1-90 天的消费趋势,支持按日 / 周 / 月聚合。

    http://127.0.0.1:3000/api/admin/consumptions/trend

  • GET/api/admin/codes/stats

    查看全局统计与项目级统计结果。

    http://127.0.0.1:3000/api/admin/codes/stats

联调命令

用 smoke 脚本做整条链路回归;文档与 SDK 路径可作为发给接入方的资源入口。

自动化烟雾测试

自动完成登录、建项目、生成次数卡、激活、状态查询、幂等扣次等整条链路验证。

BASE_URL=http://127.0.0.1:3000 npm run smoke:license-api
  • 详细对接文档

    适合把完整 API 文档同步给前端、测试或第三方接入方。

    docs/api/integration.md
  • 复用 SDK 源码

    如果你的插件也是 JS / TS 生态,直接复用 SDK 比手写 fetch 更稳。

    src/lib/license-sdk.ts