# API Key 获取与使用 — 创建密钥与三协议鉴权方式

Source: https://ofox.io/zh/docs/develop/authentication

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

## 获取 API Key

1. 注册并登录 [OfoxAI 控制台](https://app.ofox.io)
2. 进入 **设置** → **API Keys**
3. 点击 **创建新密钥**
4. 复制并安全保存你的 API Key

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

## 认证方式

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

**OpenAI 兼容**

**OpenAI 兼容协议**使用 `Authorization` Header：

```bash
Authorization: Bearer <你的 OFOXAI_API_KEY>
```

```python
from openai import OpenAI

client = OpenAI(
    base_url="https://api.ofox.io/v1",
    api_key="<你的 OFOXAI_API_KEY>"
)
```

**Anthropic 原生**

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

```bash
x-api-key: <你的 OFOXAI_API_KEY>
```

```python
import anthropic

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

**Gemini 原生**

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

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

```python
from google import genai

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

## 环境变量配置

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

```bash filename=".env"
OFOX_API_KEY=<你的 OFOXAI_API_KEY>

# 也可以设置协议专用的环境变量
OPENAI_API_KEY=<你的 OFOXAI_API_KEY>
OPENAI_BASE_URL=https://api.ofox.io/v1

ANTHROPIC_API_KEY=<你的 OFOXAI_API_KEY>
ANTHROPIC_BASE_URL=https://api.ofox.io/anthropic

GEMINI_API_KEY=<你的 OFOXAI_API_KEY>
GEMINI_BASE_URL=https://api.ofox.io/gemini
```

## 安全最佳实践

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

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