orientxorientx

密钥与身份验证

创建密钥、发送 Authorization,以及处理 401 / 403

密钥用于标识你的账户,并决定可以访问哪些模型。在控制台中创建和撤销密钥。 你也可以随时在控制台中再次查看密钥的值。

不要将密钥发送到浏览器

客户端 JavaScript、移动应用二进制文件或公开仓库中的内容,任何人都可能读取。 应从你自己的后端调用 API,再让前端访问该后端。

以下做法有助于管理密钥:

  • 每个环境使用独立密钥。 分开管理开发、预发布和生产环境,避免撤销一个密钥时影响其他环境。
  • 从环境变量读取。 在运行时读取 ORIENTX_API_KEY,不要硬编码。
  • 泄露后立即轮换。 如果密钥出现在日志、截图或代码提交中,请立即撤销。

身份验证

每个请求都在 Authorization 请求头中携带密钥:

Authorization: Bearer <ORIENTX_API_KEY>

密钥缺失、格式错误或已被撤销时,返回 401:

{
  "error": {
    "message": "Invalid API key provided.",
    "type": "invalid_request_error",
    "code": "invalid_api_key"
  }
}

如果密钥有效,但无权访问请求中的模型,则返回 403。 完整状态码列表参见速率限制与错误。

本页目录