鉴权与约定

鉴权方式

① JWT 登录态(控制台同源接口)

适用于模拟控制台操作的完整 REST API。先登录换取令牌:

curl -s -X POST https://www.chyjz.com/api/v1/auth/tenant/login \
  -H "Content-Type: application/json" \
  -d '{"username":"你的账号","password":"你的密码"}'

后续请求携带 Authorization: Bearer <token>;令牌过期后调用 POST /auth/refresh 续期。

② API Key(MCP / 自动化场景)

在控制台「个人设置 → API 密钥」创建,形如 sp_xxxx,每个租户最多 5 个。请求头携带 Authorization: Bearer sp_xxxx 即可。API Key 明文仅在创建时展示一次,请妥善保存;泄露时立即在控制台删除重建。

通用约定

{
  "code": 0,          // 0 成功,非 0 为业务错误码
  "message": "success",
  "data": { ... },    // 业务数据(列表接口含 list/total)
  "trace_id": "..."   // 排查问题请提供此 ID
}
安全提醒:切勿在浏览器 / 公开仓库暴露 API Key 或 JWT;服务端集成建议放在后端代理。