认证指南

所有 API 请求都需要通过 API Key 进行身份认证。OfoxAI 使用统一的 API Key，支持三大协议的认证方式。

获取 API Key

注册并登录 OfoxAI 控制台
进入设置 → API Keys
点击 创建新密钥
复制并安全保存你的 API Key

API Key 仅在创建时显示一次，请务必妥善保存。如果丢失，需要重新创建。

认证方式

根据你使用的协议，认证方式略有不同：

OpenAI 兼容

OpenAI 兼容协议使用 Authorization Header：


Authorization: Bearer <你的 OFOXAI_API_KEY>


from openai import OpenAI
 
client = OpenAI(
    base_url="https://api.ofox.run/v1",
    api_key="<你的 OFOXAI_API_KEY>"
)

Anthropic 原生

Anthropic 原生协议使用 x-api-key Header：


x-api-key: <你的 OFOXAI_API_KEY>


import anthropic
 
client = anthropic.Anthropic(
    base_url="https://api.ofox.run/anthropic",
    api_key="<你的 OFOXAI_API_KEY>"
)

Gemini 原生

Gemini 原生协议使用 x-goog-api-key Header 或 URL 参数：


x-goog-api-key: <你的 OFOXAI_API_KEY>


from google import genai
 
client = genai.Client(
    api_key="<你的 OFOXAI_API_KEY>",
    http_options={"api_version": "v1beta", "base_url": "https://api.ofox.run/gemini",}
)

环境变量配置

推荐使用环境变量管理 API Key，避免硬编码：

.env


OFOX_API_KEY=<你的 OFOXAI_API_KEY>
 
# 也可以设置协议专用的环境变量
OPENAI_API_KEY=<你的 OFOXAI_API_KEY>
OPENAI_BASE_URL=https://api.ofox.run/v1
 
ANTHROPIC_API_KEY=<你的 OFOXAI_API_KEY>
ANTHROPIC_BASE_URL=https://api.ofox.run/anthropic
 
GEMINI_API_KEY=<你的 OFOXAI_API_KEY>
GEMINI_BASE_URL=https://api.ofox.run/gemini

安全最佳实践

使用环境变量 — 永远不要在代码中硬编码 API Key
定期轮换密钥 — 建议每 90 天更换一次
区分环境 — 开发和生产环境使用不同的 API Key
监控用量 — 定期检查控制台的 API 用量和异常调用
限制权限 — 为不同项目创建独立的 API Key，便于追踪和管理

切勿将 API Key 提交到 Git 仓库或暴露在客户端代码中。使用 .gitignore 排除 .env 文件。