Clés API
Les clés API de la plateforme Ultralytics permettent un accès programmatique sécurisé pour l'entraînement à distance, l'inférence et l'automatisation. Créez des clés avec des permissions spécifiques et limitées pour différents cas d'utilisation.
Créer une clé API
Créer une nouvelle clé API :
- Accédez à Paramètres > Clés API
- Cliquez sur Créer une clé
- Saisissez un nom pour la clé
- Sélectionnez les portées de permission
- Cliquez sur Créer
Nom de la clé
Donnez un nom descriptif à votre clé :
training-server- Pour les machines d'entraînement à distanceci-pipeline- Pour l'intégration CI/CDmobile-app- Pour les applications mobiles
Portées d'autorisation
Sélectionnez les portées pour limiter les permissions de la clé :
| Portée | Permissions |
|---|---|
| formation | Démarrer l'entraînement, diffuser les métriques |
| modèles | Charger, télécharger, supprimer des modèles |
| jeux de données | Accéder et modifier les jeux de données |
| lecture | Accès en lecture seule à toutes les ressources |
| écriture | Accès en écriture complet |
| admin | Gestion de compte (à utiliser avec prudence) |
Moindre privilège
Créez des clés avec uniquement les permissions nécessaires. Utilisez des clés distinctes pour différentes applications.
Affichage de la clé
Après la création, la clé est affichée une seule fois :
Copiez votre clé
La clé complète n'est affichée qu'une seule fois. Copiez-la immédiatement et stockez-la en toute sécurité. Vous ne pourrez pas la récupérer ultérieurement.
Format de la clé
Les clés API suivent ce format :
ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0
- Préfixe:
ul_identifie les clés Ultralytics - Corps : 40 caractères hexadécimaux aléatoires
- Total : 43 caractères
Utilisation des clés API
Variable d'environnement
Définissez votre clé comme variable d'environnement :
export ULTRALYTICS_API_KEY="ul_your_key_here"
$env:ULTRALYTICS_API_KEY = "ul_your_key_here"
Dans le code
Utilisez la clé dans vos scripts Python :
import os
# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")
# Or directly (not recommended for production)
api_key = "ul_your_key_here"
En-têtes HTTP
Incluez la clé dans les requêtes API :
curl -H "Authorization: Bearer ul_your_key_here" \
https://platform.ultralytics.com/api/...
Entraînement à distance
Activez le streaming de métriques avec votre clé.
Version de package requise
L'intégration à la plateforme nécessite ultralytics>=8.4.0. Les versions antérieures NE fonctionneront PAS avec la plateforme.
pip install "ultralytics>=8.4.0"
export ULTRALYTICS_API_KEY="ul_your_key_here"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1
Gérer les clés
Afficher les clés
Toutes les clés sont listées dans Paramètres > Clés API :
| Colonne | Description |
|---|---|
| Nom | Identifiant de la clé |
| Portées | Permissions attribuées |
| Créée | Date de création |
| Dernière utilisation | Dernière utilisation |
Révoquer la clé
Révoquer une clé compromise ou qui n'est plus nécessaire :
- Cliquez sur le menu de la clé
- Sélectionnez Révoquer
- Confirmez la révocation
Effet immédiat
La révocation est immédiate. Toutes les applications utilisant cette clé cesseront de fonctionner.
Régénérer la clé
Si une clé est compromise :
- Créez une nouvelle clé avec les mêmes portées
- Mettez à jour vos applications
- Révoquez l'ancienne clé
Bonnes pratiques de sécurité
À faire
- Stockez les clés dans des variables d'environnement
- Utilisez des clés distinctes pour différents environnements
- Révoquez rapidement les clés inutilisées
- Utilisez les portées minimales requises
- Faites pivoter les clés périodiquement
À ne pas faire
- Ne pas commiter les clés dans le contrôle de version
- Ne pas partager les clés entre applications
- Ne pas utiliser la portée administrateur inutilement
- Ne pas enregistrer les clés dans la sortie de l'application
- Ne pas intégrer les clés dans le code côté client
Rotation des clés
Faites pivoter les clés périodiquement pour la sécurité :
- Créez une nouvelle clé avec les mêmes portées
- Mettez à jour les applications pour utiliser la nouvelle clé
- Vérifiez que les applications fonctionnent correctement
- Révoquer l'ancienne clé
Calendrier de rotation
Envisagez de faire pivoter les clés tous les 90 jours pour les applications sensibles.
Dépannage
Erreur de clé invalide
Error: Invalid API key
Solutions :
- Vérifier que la clé est copiée correctement
- Vérifier que la clé n'a pas été révoquée
- S'assurer que la clé dispose des étendues requises
- Confirmer que la variable d'environnement est définie
Permission refusée
Error: Permission denied for this operation
Solutions :
- Vérifier que les étendues de la clé incluent la permission requise
- Vérifier que vous êtes le propriétaire de la ressource
- Créer une nouvelle clé avec les étendues correctes
Limite de débit atteinte
Error: Rate limit exceeded
Solutions :
- Réduire la fréquence des requêtes
- Mettre en œuvre un backoff exponentiel
- Contacter le support pour une augmentation de la limite
FAQ
Combien de clés puis-je créer ?
Il n'y a pas de limite stricte sur le nombre de clés API. Créez-en autant que nécessaire pour vos différentes applications et environnements.
Les clés expirent-elles ?
Les clés n'expirent pas automatiquement. Elles restent valides jusqu'à leur révocation. Envisagez de mettre en œuvre une rotation pour des raisons de sécurité.
Puis-je voir ma clé après sa création ?
Non, la clé complète n'est affichée qu'une seule fois lors de sa création. En cas de perte, créez une nouvelle clé et révoquez l'ancienne.
Les clés sont-elles spécifiques à une région ?
Les clés fonctionnent dans toutes les régions, mais n'accèdent aux données que dans la région de votre compte.
Puis-je partager des clés avec les membres de mon équipe ?
Meilleure pratique : Chaque membre de l'équipe devrait créer sa propre clé. Cela permet :
- Suivi individuel de l'activité
- Révocation sélective
- Contrôle d'accès approprié
