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 des clés nommées avec un chiffrement AES-256-GCM pour différents cas d'utilisation.

Créer une clé API

Crée une nouvelle clé API :

1. Va dans Paramètres > Clés API
2. Clique sur Créer une clé
3. Saisis un nom pour la clé (par ex. "Serveur d'entraînement")
4. Clique sur 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 sa création, la clé est affichée une seule fois :

Format de clé

Les clés API suivent ce format :

• 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 hash SHA-256 pour une recherche rapide du préfixe et une comparaison de hash
• Les valeurs complètes des clés ne sont jamais stockées en texte brut

Utilisation des clés API

Variable d'environnement

Définit ta clé en tant que variable d'environnement :

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI

Définit la clé en utilisant le YOLO CLI :

yolo settings api_key="YOUR_API_KEY"

Dans le code

Utilise la clé dans tes scripts Python :

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

En-têtes HTTP

Inclut 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 distant

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

pip install "ultralytics>=8.4.35"

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

Consulte Entraînement Cloud pour le guide complet de l'entraînement à distance.

Gérer les clés

Voir les clés

All keys are listed on the Settings > API Keys tab:

Chaque carte de clé affiche le nom de la clé, la valeur complète déchiffrée de la clé (copiable), le temps de création relatif et un bouton de révocation.

Révoquer une clé

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

1. Trouve la clé dans la section Clés API
2. Clique sur le bouton Révoquer (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 d'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

Lorsque tu changes d'espace de travail dans la barre latérale, la section Clés API affiche les clés de cet espace de travail. Un rôle d'éditeur ou supérieur est requis pour gérer les clés API de l'espace de travail. Voir Équipes 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 séparées pour différents environnements
• Révoque rapidement les clés inutilisées
• Fais tourner les clés périodiquement
• Utilise des noms descriptifs pour identifier les finalités des clés

À ne pas faire

• Ne soumets pas les clés au contrôle de version
• Ne partage pas les clés entre les applications
• N'enregistre pas les clés dans les sorties d'application
• N'intègre pas les clés dans le code côté client

Rotation des clés

Fais tourner 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

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

Permission refusée

Solutions :

1. Vérifie que tu es le propriétaire de la ressource ou que tu as l'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

Limitation de débit

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 interruption exponentielle (exponential backoff) en utilisant l'en-tête Retry-After
3. Utilise un point de terminaison dédié pour un débit d'inférence illimité

FAQ

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

Il n'y a pas de limite stricte sur les clés API. Crée 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'à leur révocation. Pense à mettre en place une rotation pour plus de 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 sous 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 n'accèdent qu'aux données de la région de ton compte.

Puis-je partager mes clés avec les membres de mon équipe ?

Bonne pratique : demande à chaque membre de l'é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.