PUBLIC API DOCS
Auth API Integration Docs
本页面是对外开发文档(无需管理员登录),仅描述系统集成方可调用的接口能力。
OpenAPI 规范文件:/openapi.yaml
Base URL:https://auth_api.6lai.com
Response Envelope
所有接口统一返回以下外层结构:
{
"status": 1,
"msg": "ok",
"data": {...}
}
Success Example
{
"status": 1,
"msg": "ok",
"data": {
"allow_upgrade": 1
}
}
Error Responses
status = 0:业务校验失败(签名错误、参数不合法、鉴权失败等)。- HTTP 500 且
status = 0:服务端内部异常。
{
"status": 0,
"msg": "invalid request",
"data": null
}
Public API List
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /api/v1/verify |
签名 | License 校验与升级授权检查(兼容旧客户端)。 |
| POST | /api/v1/agent/register |
签名 | Agent 注册并签发短期访问 token。 |
| POST | /api/v1/agent/poll |
Bearer token + 签名 | Agent 拉取待执行任务(upgrade/rollback/retry/noop)。 |
| POST | /api/v1/agent/report |
Bearer token + 签名 | Agent 上报任务阶段、状态与进度。 |
| POST | /api/v1/agent/heartbeat |
Bearer token + 签名 | Agent 心跳保活与在线状态更新。 |
| POST | /api/v1/release/latest |
Bearer token + 签名 | 按 tenant/channel 查询最新可用发布版本。 |
POST /api/v1/verify
请求体字段:
{
"project_code": "string",
"license_id": "string",
"domain": "string",
"server_ip": "string",
"machine_fingerprint": "string",
"current_version": "string",
"action": "check | upgrade",
"timestamp": 1700000000,
"nonce": "string",
"sign": "hex string"
}
POST /api/v1/agent/register
{
"tenant_id": "tenant-001",
"agent_id": "agent-001",
"license_id": "LIC-1001",
"domain": "example.com",
"machine_fingerprint": "fp-001",
"channel": "stable",
"timestamp": 1700000000,
"nonce": "nonce-001",
"sign": "hex string"
}
成功后返回 access_token,后续 Agent 接口通过 Authorization: Bearer <token> 携带。
POST /api/v1/release/latest
{
"tenant_id": "tenant-001",
"channel": "stable",
"current_version": "1.0.0",
"timestamp": 1700000000,
"nonce": "nonce-002",
"sign": "hex string"
}
返回值包含 latest 与 has_update,用于现有系统执行更新检查。
Notes
timestamp与nonce需唯一并在有效时间窗口内,服务端会做防重放校验。- 签名字段
sign使用约定参数集进行 HMAC-SHA256 计算。 - Agent 的
access_token为短期令牌,过期后需重新注册获取。