Authentification
Toutes les requêtes API nécessitent une authentification par clé API. OfoxAI utilise une clé API unifiée compatible avec les trois protocoles d’authentification.
Obtenir une clé API
- Inscrivez-vous et connectez-vous à la console OfoxAI
- Allez dans Paramètres → Clés API
- Cliquez sur Créer une nouvelle clé
- Copiez et conservez votre clé API en lieu sûr
La clé API n’est affichée qu’une seule fois lors de sa création. Assurez-vous de la conserver en lieu sûr. En cas de perte, vous devrez en créer une nouvelle.
Méthodes d’authentification
Selon le protocole utilisé, la méthode d’authentification varie légèrement :
Compatible OpenAI
Le protocole compatible OpenAI utilise le Header Authorization :
Authorization: Bearer <votre OFOXAI_API_KEY>from openai import OpenAI
client = OpenAI(
base_url="https://api.ofox.ai/v1",
api_key="<votre OFOXAI_API_KEY>"
)Configuration des variables d’environnement
Il est recommandé de gérer la clé API via des variables d’environnement pour éviter de la coder en dur :
.env
OFOX_API_KEY=<votre OFOXAI_API_KEY>
# Vous pouvez également configurer des variables d'environnement spécifiques au protocole
OPENAI_API_KEY=<votre OFOXAI_API_KEY>
OPENAI_BASE_URL=https://api.ofox.ai/v1
ANTHROPIC_API_KEY=<votre OFOXAI_API_KEY>
ANTHROPIC_BASE_URL=https://api.ofox.ai/anthropic
GEMINI_API_KEY=<votre OFOXAI_API_KEY>
GEMINI_BASE_URL=https://api.ofox.ai/geminiBonnes pratiques de sécurité
- Utilisez des variables d’environnement — Ne codez jamais la clé API en dur dans le code
- Effectuez une rotation régulière des clés — Il est recommandé de les changer tous les 90 jours
- Séparez les environnements — Utilisez des clés API différentes pour le développement et la production
- Surveillez l’utilisation — Vérifiez régulièrement l’utilisation de l’API et les appels anormaux dans la console
- Limitez les permissions — Créez des clés API indépendantes pour chaque projet pour faciliter le suivi et la gestion
Ne commettez jamais la clé API dans des dépôts Git et ne l’exposez pas dans du code côté client. Utilisez .gitignore pour exclure les fichiers .env.
Last updated on