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 à portée limitée avec des autorisations spécifiques pour différents cas d'utilisation.

Créer une clé API

Créer une nouvelle clé API :

1. Allez dans Paramètres > Clés API
2. Cliquez sur Créer une clé
3. Entrez un nom pour la clé.
4. Sélectionner les champs d'application des autorisations
5. Cliquez sur Créer

Nom de la clé

Donnez à votre clé un nom descriptif :

• training-server - Pour les machines d'entraînement à distance
• ci-pipeline - Pour l'intégration CI/CD
• mobile-app - Pour les applications mobiles

Portées des autorisations

Sélectionnez les champs d'application pour limiter les autorisations clés :

Affichage des touches

Après la création, la clé s'affiche une seule fois :

Format de clé

Les clés API respectent le format suivant :

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• Préfixe: ul_ identifie 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 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

Inclure la clé dans les requêtes API :

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

Formation à distance

Activez le streaming métrique avec votre clé.

pip install "ultralytics>=8.4.0"

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

Gérer les clés

Afficher les touches

Toutes les clés sont répertoriées dans Paramètres > Clés API :

Révoquer la clé

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

1. Cliquez sur le menu de la clé.
2. Sélectionner Révoquer
3. Confirmer la révocation

Régénérer la clé

Si une clé est compromise :

1. Créer une nouvelle clé avec les mêmes champs d'application
2. Mettez à jour vos applications
3. Révoquer l'ancienne clé

Meilleures pratiques en matière de sécurité

Faire

• Stocker 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 champs d'application minimaux requis
• Tourner les clés périodiquement

Ne pas

• Commettre les clés dans le contrôle de version
• Partager des clés entre applications
• Utilisation inutile du champ d'application admin
• Enregistrer les clés dans la sortie de l'application
• Intégrer des clés dans le code côté client

Rotation des clés

Faites tourner les clés régulièrement pour des raisons de sécurité :

1. Créer une nouvelle clé avec les mêmes champs d'application
2. Mettre à jour les applications pour utiliser la nouvelle clé
3. Vérifier 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.
2. Vérifier que la clé n'a pas été révoquée
3. S'assurer que la clé dispose des champs d'application requis
4. Vérifiez que la variable d'environnement est définie.

Autorisation refusée

Error: Permission denied for this operation

Solutions :

1. Vérifier que les champs d'application des clés incluent les autorisations requises
2. Vérifiez que vous êtes bien le propriétaire de la ressource.
3. Créer une nouvelle clé avec les champs d'application corrects

Taux limité

Error: Rate limit exceeded

Solutions :

1. Réduire la fréquence des demandes
2. Mettre en œuvre un recul exponentiel
3. Contactez le service d'assistance pour augmenter votre limite

FAQ

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

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

Les clés ont-elles une date d'expiration ?

Les clés n'expirent pas automatiquement. Elles restent valides jusqu'à leur révocation. Envisagez de mettre en place 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. Si vous la perdez, créez une nouvelle clé et révoquez l'ancienne.

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

Les clés fonctionnent dans toutes les régions, mais vous ne pouvez accéder qu'aux données de 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é. Cela permet :

• Suivi des activités individuelles
• Révocation sélective
• Contrôle d'accès approprié

📅 Créé il y a 0 jour ✏️ Mis à jour il y a 0 jour

Commentaires