Clés API

Les clés API Ultralytics permettent un accès programmatique sécurisé pour la formation à distance, l'inférence et l'automatisation. Créez des clés nommées avec un cryptage AES-256-GCM pour différents cas d'utilisation.

Créer une clé API

Créer une nouvelle clé API :

1. Accédez à Paramètres > Profil
2. Faites défiler jusqu'à la section Clés API.
3. Cliquez sur Créer une clé
4. Entrez un nom pour la clé (par exemple, « Serveur de formation »).
5. Cliquez sur Créer une clé

Nom de la clé

Donnez un nom descriptif à votre clé :

• 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é est affichée une seule fois :

Format de la 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 cryptage AES-256-GCM.
• L'authentification utilise le hachage SHA-256 pour une recherche rapide des préfixes et une comparaison des hachages.
• Les valeurs complètes des clés ne sont jamais stockées en clair.

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"

YOLO CLI

Définissez la clé à l'aide de l'interfaceCLI YOLO :

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

Consultez la REST API pour connaître tous les points de terminaison disponibles.

Entraînement à distance

Activez le streaming de métriques avec votre clé.

pip install "ultralytics>=8.4.14"

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

Consultez la section Formation sur le cloud pour obtenir le guide complet de formation à distance.

Gérer les clés

Afficher les clés

Toutes les clés sont répertoriées dans Settings > Profile dans la section Clés API :

Chaque carte clé affiche le nom de la clé, la valeur complète décryptée de la clé (copiable), l'heure relative de création et un bouton de révocation.

Révoquer la clé

Révoquer une clé compromise ou qui n'est plus nécessaire :

1. Trouvez la clé dans la section Clés API.
2. Cliquez sur le bouton Révoquer (corbeille).
3. Confirmez la révocation

Régénérer la clé

Si une clé est compromise :

1. Créer une nouvelle clé avec le même nom
2. Mettez à jour vos applications
3. Révoquez 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 comme votre compte personnel.
• Espace de travail de l'équipe: les clés s'authentifient dans le contexte de l'équipe.

Lorsque vous changez d'espace de travail dans la barre latérale, la section Clés API affiche les clés de cet espace de travail. Le rôle Éditeur ou supérieur est requis pour gérer les clés API de l'espace de travail. Consultez la section Équipes pour plus de détails sur les rôles.

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
• Faites pivoter les clés périodiquement
• Utilisez des noms descriptifs pour identifier les objectifs clés.

À 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 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é :

1. Créer une nouvelle clé avec le même nom
2. Mettez à jour les applications pour utiliser la nouvelle clé
3. Vérifiez que les applications fonctionnent correctement
4. Révoquer l'ancienne clé

Dépannage

Erreur de clé invalide

Error: Invalid API key

Solutions :

1. Vérifiez que la clé a été copiée correctement (y compris le ul_ préfixe)
2. Vérifier que la clé n'a pas été révoquée
3. Confirmer que la variable d'environnement est définie
4. Assurez-vous que vous utilisez ultralytics>=8.4.14

Permission refusée

Error: Permission denied for this operation

Solutions :

1. Vérifiez que vous êtes le propriétaire de la ressource ou que vous disposez d'un accès approprié à l'espace de travail.
2. Vérifiez que la clé appartient au bon espace de travail.
3. Créez une nouvelle clé si nécessaire.

Limite de débit atteinte

Error: Rate limit exceeded

Solutions :

1. Réduire la fréquence des requêtes — voir le tableau des limites de débit pour les limites par point de terminaison
2. Implémenter le backoff exponentiel à l'aide de la fonction Retry-After en-tête
3. Utilisez 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 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 ?

Oui, les valeurs complètes des clés sont visibles dans la liste des clés sur Settings > ProfileLa plateforme décrypte et affiche vos clés afin que vous puissiez les copier à tout moment.

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 : demandez à chaque membre de l'équipe de créer sa propre clé. Pour les espaces de travail d'équipe, chaque membre ayant le rôle Éditeur ou supérieur peut créer des clés spécifiques à cet espace de travail.

📅 Créé il y a 1 mois ✏️ Mis à jour il y a 5 jours

Commentaires