Clés API#

Les clés d'API Ultralytics Platform permettent un accès programmatique sécurisé pour l'entraînement distant, l'inférence et l'automatisation. Créez des clés nommées avec un chiffrement AES-256-GCM pour différents cas d'utilisation.

Créer une clé API#

Créer une nouvelle clé API :

1. Va dans Settings > API Keys (Paramètres > Clés API)
2. Clique sur Create Key (Créer une clé)
3. Saisis un nom pour la clé (par exemple, « Serveur d'entraînement »)
4. Clique sur Create Key (Créer une clé)

Nom de la clé#

Donne à ta clé un nom descriptif :

• training-server - Pour les machines d'entraînement distantes
• ci-pipeline - Pour l'intégration CI/CD
• local-dev - Pour le développement local

Affichage de la clé#

Après la création, la clé s'affiche dans une boîte de dialogue de confirmation :

Format de clé#

Les clés API suivent ce format :

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Préfixe : ul_ identifie les clés Ultralytics
• Corps : 40 caractères hexadécimaux aléatoires
• Total : 43 caractères

Sécurité des clés#

• Les clés sont stockées avec un chiffrement AES-256-GCM, jamais en texte clair
• Les 11 premiers caractères (ul_ plus 8 caractères hexadécimaux) servent de préfixe d'affichage, ce qui permet d'identifier une clé sans l'exposer

Utiliser des clés API#

Variable d'environnement#

Définit ta clé comme variable d'environnement :

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Valide et enregistre la clé à l'aide de la YOLO CLI :

yolo login YOUR_API_KEY

Supprime la clé enregistrée avec yolo logout.

En-têtes HTTP#

Inclus la clé dans les requêtes API :

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://platform.ultralytics.com/api/...

Ou passe-le au SDK Python (pip install "ultralytics-platform>=0.1.5"), qui lit également ULTRALYTICS_API_KEY :

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Consulte la REST API Reference pour tous les points de terminaison disponibles.

Entraînement à distance#

Active le streaming des métriques avec ta clé.

Installe ou mets à jour le paquet Ultralytics avant de commencer :

pip install -U ultralytics

export ULTRALYTICS_API_KEY="YOUR_API_KEY"
yolo train model=yolo26n.pt data=coco.yaml project=username/project name=exp1

Consulte Cloud Training pour le guide complet de l'entraînement distant.

Gérer les clés#

Voir les clés#

Toutes les clés sont listées sur l'onglet Settings > API Keys :

Chaque carte de clé affiche le nom de la clé, la valeur de la clé copiable, l'heure de création relative et un bouton de révocation.

Révoquer une clé#

Révoque une clé qui est compromise ou dont tu n'as plus besoin :

1. Trouve la clé dans la section Clés API
2. Clique sur le bouton Revoke (corbeille)
3. Confirme la révocation

Régénérer une clé#

Si une clé est compromise :

1. Crée une nouvelle clé avec le même nom
2. Mets à jour tes applications
3. Révoque l'ancienne clé

Clés API de l'espace de travail#

Les clés API sont limitées à l'espace de travail actuellement actif :

• Espace de travail personnel : Les clés s'authentifient en tant que compte personnel
• Espace de travail d'équipe : Les clés s'authentifient en tant que propriétaire de l'espace de travail d'équipe, avec toutes les permissions de propriétaire dans cet espace de travail

Lors du changement d'espace de travail dans la barre latérale, la section Clés API affiche les clés de cet espace de travail. Étant donné qu'une clé d'espace de travail confère des permissions de propriétaire, seul le propriétaire de l'espace de travail peut en créer, afficher ou révoquer une. Consulte Teams pour plus de détails sur les rôles.

Clés de travail On Premise#

La connexion d'un hôte On Premise génère une clé de travail distincte. Les clés de travail sont gérées depuis l'intégration On Premise plutôt que depuis cet onglet, ne sont jamais répertoriées avec tes clés API, et sont révoquées en déconnectant l'hôte — ce qui annule également les tâches en file d'attente et en cours d'exécution de cet hôte.

Meilleures pratiques de sécurité#

À faire#

• Stocke les clés dans des variables d'environnement
• Utilise des clés distinctes pour différents environnements
• Révoque rapidement les clés inutilisées
• Fais pivoter les clés périodiquement
• Utilise des noms descriptifs pour identifier l'usage des clés

À éviter#

• Ne valide pas les clés dans le contrôle de version
• Ne partage pas les clés entre les applications
• Ne journalise pas les clés dans la sortie des applications
• N'intègre pas les clés dans le code côté client

Rotation des clés#

Fais pivoter les clés périodiquement pour la sécurité :

1. Crée une nouvelle clé avec le même nom
2. Mets à jour les applications pour utiliser la nouvelle clé
3. Vérifie que les applications fonctionnent correctement
4. Révoque l'ancienne clé

Dépannage#

Erreur de clé invalide#

Error: Invalid API key

Solutions :

1. Vérifie que la clé est copiée correctement (y compris le préfixe ul_)
2. Vérifie que la clé n'a pas été révoquée
3. Confirme que la variable d'environnement est définie
4. Assure-toi d'utiliser ultralytics>=8.4.120

Accès refusé#

Error: Permission denied for this operation

Solutions :

1. Vérifie que tu es le propriétaire de la ressource ou que tu as un accès approprié à l'espace de travail
2. Vérifie que la clé appartient au bon espace de travail
3. Si tu gères des clés dans un espace de travail d'équipe, confirme que tu es bien le propriétaire de l'espace de travail — les autres rôles obtiennent Workspace owner access required
4. Crée une nouvelle clé si nécessaire

Limite de débit dépassée#

Error: Rate limit exceeded

Solutions :

1. Réduis la fréquence des requêtes — consulte le rate limit table pour connaître les limites par catégorie
2. Implémente un backoff exponentiel en utilisant l'en-tête Retry-After
3. Utilise un dedicated endpoint lorsque tu as besoin d'une capacité d'inférence isolée

FAQ#