API Key 取得與使用

所有 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.io/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.io/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.io/gemini",}
)

環境變數設定

建議使用環境變數管理 API Key，避免硬式編碼：

.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

安全最佳實踐

使用環境變數 — 永遠不要在程式碼中硬式編碼 API Key
定期輪換金鑰 — 建議每 90 天更換一次
區分環境 — 開發和生產環境使用不同的 API Key
監控用量 — 定期檢查控制台的 API 用量和異常呼叫
限制權限 — 為不同專案建立獨立的 API Key，便於追蹤和管理

切勿將 API Key 提交到 Git 儲存庫或暴露在用戶端程式碼中。使用 .gitignore 排除 .env 檔案。