Аутентификация

Все запросы к API требуют аутентификации через API Key. OfoxAI использует единый API Key, поддерживающий аутентификацию всех трёх протоколов.

Получение API Key

1. Зарегистрируйтесь и войдите в консоль OfoxAI 
2. Перейдите в Настройки → API Keys
3. Нажмите Создать новый ключ
4. Скопируйте и безопасно сохраните ваш API Key

Способы аутентификации

Способ аутентификации немного различается в зависимости от используемого протокола:

Authorization: Bearer <Ваш OFOXAI_API_KEY>

from openai import OpenAI
 
client = OpenAI(
    base_url="https://api.ofox.ai/v1",
    api_key="<Ваш OFOXAI_API_KEY>"
)

x-api-key: <Ваш OFOXAI_API_KEY>

import anthropic
 
client = anthropic.Anthropic(
    base_url="https://api.ofox.ai/anthropic",
    api_key="<Ваш OFOXAI_API_KEY>"
)

x-goog-api-key: <Ваш OFOXAI_API_KEY>

from google import genai
 
client = genai.Client(
    api_key="<Ваш OFOXAI_API_KEY>",
    http_options={"base_url": "https://api.ofox.ai/gemini"}
)

Настройка переменных окружения

Рекомендуется управлять API Key через переменные окружения, избегая жёсткого кодирования:

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

Лучшие практики безопасности

1. Используйте переменные окружения — никогда не вставляйте API Key прямо в код
2. Регулярная ротация ключей — рекомендуется менять каждые 90 дней
3. Разделение сред — используйте разные API Key для разработки и продакшена
4. Мониторинг использования — регулярно проверяйте использование API и аномальные вызовы в консоли
5. Ограничение прав — создавайте отдельные API Key для разных проектов для удобного отслеживания и управления