Autenticação

Todas as requisições à API requerem autenticação via API Key. O OfoxAI utiliza uma API Key unificada que funciona em todos os três protocolos.

Obtendo sua API Key

1. Cadastre-se e faça login no Console do OfoxAI 
2. Acesse Configurações → API Keys
3. Clique em Criar Nova Chave
4. Copie e armazene sua API Key com segurança

Métodos de Autenticação

O método de autenticação varia ligeiramente dependendo do protocolo utilizado:

Authorization: Bearer <sua OFOXAI_API_KEY>

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

x-api-key: <sua OFOXAI_API_KEY>

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

x-goog-api-key: <sua OFOXAI_API_KEY>

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

Configuração de Variáveis de Ambiente

Recomendamos o uso de variáveis de ambiente para gerenciar sua API Key e evitar hardcoding:

OFOX_API_KEY=<sua OFOXAI_API_KEY>
 
# Você também pode definir variáveis de ambiente específicas por protocolo
OPENAI_API_KEY=<sua OFOXAI_API_KEY>
OPENAI_BASE_URL=https://api.ofox.ai/v1
 
ANTHROPIC_API_KEY=<sua OFOXAI_API_KEY>
ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic
 
GEMINI_API_KEY=<sua OFOXAI_API_KEY>
GEMINI_BASE_URL=https://api.ofox.ai/gemini

Melhores Práticas de Segurança

1. Use variáveis de ambiente — Nunca codifique API Keys diretamente no código-fonte
2. Rotacione chaves regularmente — Recomendamos a rotação a cada 90 dias
3. Separe ambientes — Use API Keys diferentes para desenvolvimento e produção
4. Monitore o uso — Verifique regularmente o uso da API e chamadas anômalas no console
5. Limite o escopo — Crie API Keys separadas para diferentes projetos para facilitar o rastreamento e gerenciamento