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ée les 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 à distance
• 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
• L'authentification utilise un hachage SHA-256 pour une recherche indexée rapide
• Les valeurs complètes des clés ne sont jamais stockées en texte brut

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/...

Consulte la Référence REST API 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 d'entraînement à distance.

Gérer les clés#

Voir les clés#

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

Chaque carte de clé indique le nom de la clé, la valeur de la clé copiable, l'heure de création relative, le nombre d'utilisations 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 dans le contexte de l'équipe

Lors du changement d'espace de travail dans la barre latérale, la section Clés API affiche les clés pour cet espace. Le rôle Éditeur ou supérieur est requis pour gérer les clés API de l'espace de travail. Voir Teams pour les détails sur les rôles.

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 correctement copiée (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.104

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. 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 tableau des limites de débit pour les limites par point de terminaison
2. Implémente une temporisation exponentielle (exponential backoff) en utilisant l'en-tête Retry-After
3. Utilise un endpoint dédié lorsque tu as besoin d'une capacité d'inférence isolée

FAQ#

Combien de clés puis-je créer ?#

Il n'y a pas de limite stricte sur les clés API. Crée-en autant que nécessaire pour différentes applications et environnements.

Les clés expirent-elles ?#

Les clés n'expirent pas automatiquement. Elles restent valides jusqu'à ce qu'elles soient révoquées. Pense à implémenter une rotation pour la sécurité.

Puis-je voir ma clé après sa création ?#

Oui, les valeurs complètes des clés sont visibles dans la liste des clés sur Settings > API Keys. La plateforme déchiffre et affiche tes clés afin que tu puisses les copier à tout moment.

Les clés sont-elles spécifiques à une région ?#

Les clés fonctionnent entre les régions mais accèdent uniquement aux données de la région de ton compte.

Est-ce que je peux partager des clés avec les membres de mon équipe ?#

Meilleure pratique : demande à chaque membre de ton équipe de créer sa propre clé. Pour les espaces de travail d'équipe, chaque membre ayant un rôle d'Éditeur ou supérieur peut créer des clés limitées à cet espace de travail.