認証ガイド
すべてのAPIリクエストにはAPI Keyによる認証が必要です。OfoxAI は統一されたAPI Keyを使用し、3つのプロトコルの認証方式をサポートしています。
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.ai/v1",
api_key="<あなたの OFOXAI_API_KEY>"
)環境変数の設定
API Keyはハードコーディングを避け、環境変数で管理することを推奨します：
.env
OFOX_API_KEY=<あなたの OFOXAI_API_KEY>
# プロトコル別の環境変数も設定可能
OPENAI_API_KEY=<あなたの OFOXAI_API_KEY>
OPENAI_BASE_URL=https://api.ofox.ai/v1
ANTHROPIC_API_KEY=<あなたの OFOXAI_API_KEY>
ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic
GEMINI_API_KEY=<あなたの OFOXAI_API_KEY>
GEMINI_BASE_URL=https://api.ofox.ai/geminiセキュリティベストプラクティス
- 環境変数を使用 — コード内にAPI Keyをハードコーディングしないでください
- 定期的なキーローテーション — 90日ごとの更新を推奨
- 環境の分離 — 開発環境と本番環境で異なるAPI Keyを使用
- 使用量の監視 — コンソールでAPI使用量と異常なコールを定期的に確認
- 権限の制限 — プロジェクトごとに独立したAPI Keyを作成し、追跡と管理を容易に
API KeyをGitリポジトリにコミットしたり、クライアントサイドのコードに公開しないでください。.gitignoreで.envファイルを除外してください。
Last updated on