API 参考
平台管理 API 摘要与集成说明。
Docs / API
API 参考。
面向集成与自动化的接口摘要。鉴权方式、字段级 Schema 以实际版本 OpenAPI / 管理端「开发者」说明为准。
鉴权约定
管理 API 通常使用 Bearer Token 或会话 Cookie(登录后获取)。请勿在浏览器控制台、截图或公共仓库泄露 Token。所有写操作应在授权演练租户上下文中执行。
平台管理 API(客户部署实例)
基址示例:https://<your-taigong-host>/api
| 方法 | 路径(示意) | 说明 |
|---|---|---|
POST | /api/login | 管理员登录,获取会话 / Token |
GET | /api/campaigns | 演练活动列表 |
POST | /api/campaigns | 创建演练(模板、目标组、发送策略) |
GET | /api/campaigns/{id}/results | 打开 / 点击 / 提交等结果 |
GET/POST | /api/groups、/api/targets | 目标组与目标用户 |
GET/POST | /api/templates | 邮件 / 消息模板 |
GET/POST | /api/landing_pages | 钓鱼落地页 |
POST | /api/ai/* | AI 辅助生成(受 License 与策略限制) |
POST | /api/evasion/*、/api/smuggling/* | 高价值对抗能力(受授权与策略限制) |
GET | /api/users、/api/roles | RBAC 用户与角色 |
实时事件可通过 WebSocket 订阅演练进度(具体路径以版本为准),避免高频轮询压垮数据库。完整字段与错误码见交付包内 OpenAPI / 开发者说明。