API-Schlüssel

Ultralytics Platform API-Schlüssel ermöglichen sicheren programmatischen Zugriff für Remote-Training, Inferenz und Automatisierung. Erstellen Sie bereichsbezogene Schlüssel mit spezifischen Berechtigungen für verschiedene Anwendungsfälle.

API-Schlüssel erstellen

Neuen API-Schlüssel erstellen:

1. Gehen Sie zu Einstellungen > API-Schlüssel
2. Klicken Sie auf Schlüssel erstellen
3. Geben Sie einen Namen für den Schlüssel ein
4. Berechtigungsbereiche auswählen
5. Klicken Sie auf Erstellen

Schlüsselname

Geben Sie Ihrem Schlüssel einen aussagekräftigen Namen:

• training-server - Für Remote-Trainingsmaschinen
• ci-pipeline - Für CI/CD-Integration
• mobile-app - Für mobile Anwendungen

Berechtigungsumfänge

Wählen Sie Bereiche aus, um die Schlüsselberechtigungen einzuschränken:

Schlüsselanzeige

Nach der Erstellung wird der Schlüssel einmal angezeigt:

Schlüsselformat

API-Schlüssel haben folgendes Format:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• Präfix: ul_ identifiziert Ultralytics Schlüssel
• Hauptteil: 40 zufällige hexadezimale Zeichen
• Gesamt: 43 Zeichen

Verwendung von API-Schlüsseln

Umgebungsvariable

Legen Sie Ihren Schlüssel als Umgebungsvariable fest:

export ULTRALYTICS_API_KEY="ul_your_key_here"

$env:ULTRALYTICS_API_KEY = "ul_your_key_here"

Im Code

Verwenden Sie den Schlüssel in Ihren Python-Skripten:

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"

HTTP-Header

Fügen Sie den Schlüssel in API-Anfragen ein:

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

Remote-Training

Aktivieren Sie Metrik-Streaming mit Ihrem Schlüssel.

pip install "ultralytics>=8.4.0"

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

Schlüssel verwalten

Schlüssel anzeigen

Alle Schlüssel sind unter Einstellungen > API-Schlüssel aufgeführt:

Schlüssel widerrufen

Widerrufen Sie einen Schlüssel, der kompromittiert ist oder nicht mehr benötigt wird:

1. Klicken Sie auf das Schlüsselmenü
2. Wählen Sie Widerrufen
3. Widerruf bestätigen

Schlüssel neu generieren

Wenn ein Schlüssel kompromittiert wurde:

1. Einen neuen Schlüssel mit denselben Scopes erstellen
2. Ihre Anwendungen aktualisieren
3. Den alten Schlüssel widerrufen

Bewährte Sicherheitspraktiken

Tun Sie

• Schlüssel in Umgebungsvariablen speichern
• Separate Schlüssel für verschiedene Umgebungen verwenden
• Unbenutzte Schlüssel umgehend widerrufen
• Minimal erforderliche Scopes verwenden
• Schlüssel regelmäßig rotieren

Tun Sie nicht

• Schlüssel in der Versionskontrolle ablegen
• Schlüssel zwischen Anwendungen teilen
• Admin-Scope unnötigerweise verwenden
• Schlüssel in der Anwendungsausgabe protokollieren
• Schlüssel in clientseitigem Code einbetten

Schlüsselrotation

Schlüssel aus Sicherheitsgründen regelmäßig rotieren:

1. Neuen Schlüssel mit denselben Scopes erstellen
2. Anwendungen aktualisieren, um den neuen Schlüssel zu verwenden
3. Überprüfen, ob Anwendungen korrekt funktionieren
4. Alten Schlüssel widerrufen

Fehlerbehebung

Fehler: Ungültiger Schlüssel

Error: Invalid API key

Lösungen:

1. Überprüfen, ob der Schlüssel korrekt kopiert wurde
2. Prüfen, ob der Schlüssel nicht widerrufen wurde
3. Stellen Sie sicher, dass der Schlüssel die erforderlichen Scopes besitzt
4. Bestätigen Sie, dass die Umgebungsvariable gesetzt ist

Zugriff verweigert

Error: Permission denied for this operation

Lösungen:

1. Überprüfen Sie, ob die Schlüssel-Scopes die erforderliche Berechtigung enthalten
2. Verifizieren Sie, dass Sie der Ressourcenbesitzer sind
3. Erstellen Sie einen neuen Schlüssel mit den korrekten Scopes

Ratenbegrenzung

Error: Rate limit exceeded

Lösungen:

1. Reduzieren Sie die Anfraghäufigkeit
2. Implementieren Sie exponentielles Backoff
3. Kontaktieren Sie den Support für eine Limiterhöhung

FAQ

Wie viele Schlüssel kann ich erstellen?

Es gibt keine feste Begrenzung für API-Schlüssel. Erstellen Sie so viele, wie für verschiedene Anwendungen und Umgebungen benötigt werden.

Laufen Schlüssel ab?

Schlüssel laufen nicht automatisch ab. Sie bleiben gültig, bis sie widerrufen werden. Erwägen Sie die Implementierung einer Rotation aus Sicherheitsgründen.

Kann ich meinen Schlüssel nach der Erstellung einsehen?

Nein, der vollständige Schlüssel wird nur einmal bei der Erstellung angezeigt. Geht er verloren, erstellen Sie einen neuen Schlüssel und widerrufen Sie den alten.

Sind Schlüssel regionsspezifisch?

Schlüssel funktionieren regionsübergreifend, greifen aber nur auf Daten in der Region Ihres Kontos zu.

Kann ich Schlüssel mit Teammitgliedern teilen?

Bewährte Methode: Lassen Sie jedes Teammitglied einen eigenen Schlüssel erstellen. Dies ermöglicht:

• Individuelle Aktivitätsverfolgung
• Selektiver Widerruf
• Ordnungsgemäße Zugriffskontrolle

📅 Erstellt vor 20 Tagen ✏️ Aktualisiert vor 19 Tagen

Kommentare