Skip to Content
DocumentaciónAutenticación

Autenticación

Todas las solicitudes API requieren autenticación mediante una API Key. OfoxAI utiliza una API Key unificada compatible con los tres protocolos de autenticación.

Obtener una API Key

  1. Regístrese e inicie sesión en la consola de OfoxAI 
  2. Vaya a ConfiguraciónAPI Keys
  3. Haga clic en Crear nueva clave
  4. Copie y guarde su API Key de forma segura

La API Key solo se muestra una vez al momento de crearla. Asegúrese de guardarla de forma segura. Si la pierde, deberá crear una nueva.

Métodos de autenticación

Según el protocolo que utilice, el método de autenticación varía ligeramente:

El protocolo compatible con OpenAI utiliza el Header Authorization:

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

Configuración de variables de entorno

Se recomienda gestionar la API Key mediante variables de entorno para evitar incluirla directamente en el código:

.env
OFOX_API_KEY=<su OFOXAI_API_KEY> # También puede configurar variables de entorno específicas del protocolo OPENAI_API_KEY=<su OFOXAI_API_KEY> OPENAI_BASE_URL=https://api.ofox.ai/v1 ANTHROPIC_API_KEY=<su OFOXAI_API_KEY> ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic GEMINI_API_KEY=<su OFOXAI_API_KEY> GEMINI_BASE_URL=https://api.ofox.ai/gemini

Mejores prácticas de seguridad

  1. Use variables de entorno — Nunca incluya la API Key directamente en el código
  2. Rote las claves regularmente — Se recomienda cambiarlas cada 90 días
  3. Separe los entornos — Use API Keys diferentes para desarrollo y producción
  4. Monitoree el uso — Revise regularmente el uso de la API y las llamadas anómalas en la consola
  5. Limite los permisos — Cree API Keys independientes para cada proyecto para facilitar el seguimiento y la gestión

Nunca incluya la API Key en repositorios Git ni la exponga en código del lado del cliente. Use .gitignore para excluir archivos .env.

Last updated on