认证
所有 API 请求都需要在 Authorization 请求头中传入有效的 API Key。
请求头格式
Authorization: Bearer gw-your-key-here Key 格式
API Key 遵循 gw-{name}-{hash} 格式:
gw-— DSES Gateway Key 的固定前缀{name}— 用户自定义的 Key 名称{hash}— 64 位十六进制字符串(SHA-256)
Key 的完整明文仅在创建时返回一次,数据库中只存储 SHA-256 哈希值。
Key 功能
| 功能 | 说明 |
|---|---|
| 模型白名单 | 限制该 Key 可访问的模型范围(allowed_models) |
| 消费限额 | 设置单个 Key 的最大消费额度,支持自动重置(每日 / 每周 / 每月) |
| 过期时间 | 设置 Key 的到期日期(expires_at) |
| 启用 / 禁用 | 无需删除即可立即吊销访问权限 |
错误响应
| 状态码 | 错误码 | 含义 |
|---|---|---|
| 401 | UNAUTHORIZED | 缺少或无效的 API Key |
| 403 | FORBIDDEN | Key 已禁用、已过期,或请求的模型不在白名单中 |
| 403 | INSUFFICIENT_BALANCE | 账户余额为零 |