身份验证
每个 API 请求都使用工作区创建的 Bearer Token。
Vergora API 使用 API Key 验证请求身份。所有请求都应从服务端发送,并通过
Authorization请求头传递凭证。
请求头格式
Authorization: Bearer YOUR_VERGORA_API_KEYBearer 与 API Key 之间必须保留一个空格。不要把 API Key 放在 URL 查询参数中。
创建 API Key
- 登录控制台并打开 API Keys。
- 创建一个新的 API Key。
- 使用能够识别应用和环境的名称,例如
storefront-production。 - 根据应用需要设置预算、有效期和模型访问范围。
- 按页面提示复制并安全保存完整 API Key。
配置建议
| 配置 | 建议 |
|---|---|
| 名称 | 包含应用和环境,避免使用无法识别的名称 |
| 环境 | 为开发、测试和生产分别创建 Key |
| 预算 | 根据应用的预期用量设置,不把 Key 预算理解为钱包充值 |
| 有效期 | 临时测试使用较短期限,正式环境定期检查 |
| 模型范围 | 只开放应用实际需要的模型 |
| 来源限制 | 启用后,只填写应用实际使用的出口地址 |
在应用中使用
export VERGORA_API_KEY="YOUR_VERGORA_API_KEY"应用从服务端环境变量或密钥管理工具读取该值。不要把完整 Key 写入源代码、浏览器脚本、公开仓库、日志或截图。
轮换与停止使用
- 创建替代 Key。
- 更新应用配置并发送最小请求。
- 在 Requests 中确认新 Key 的请求成功。
- 停止旧 Key 的使用。
- 检查是否还有应用继续使用旧凭证。
如果完整 Key 丢失,请按控制台提供的流程创建替代凭证。怀疑凭证泄露时,应立即停止其使用并检查相关请求记录。
鉴权失败排查
| 检查项 | 处理方式 |
|---|---|
| API Key 为空或不完整 | 重新读取服务端环境变量 |
| 请求头格式错误 | 使用 Authorization: Bearer <key> |
| Key 已到期或停止使用 | 在控制台检查状态并创建替代 Key |
| 超出预算或模型范围 | 检查 Key 策略和当前模型 |
| 来源不符合限制 | 核对应用的实际出口地址 |
第一次接入请先完成快速开始。