API-Schlüssel

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

API-Schlüssel erstellen

Erstellen Sie einen neuen API-Schlüssel:

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 Fernausbildungsmaschinen
• ci-pipeline - Für CI/CD-Integration
• mobile-app - Für mobile Anwendungen

Berechtigungsbereiche

Wählen Sie Bereiche aus, um wichtige Berechtigungen einzuschränken:

Tastenanzeige

Nach der Erstellung wird der Schlüssel einmal angezeigt:

Schlüsselformat

API-Schlüssel haben das folgende Format:

ul_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0

• Präfix: ul_ identifiziert Ultralytics
• Körper: 40 zufällige Hexadezimalzeichen
• 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 :

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

Fernschulung

Aktivieren Sie das Metrik-Streaming mit Ihrem Schlüssel.

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

Schlüssel verwalten

Ansichtstasten

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

Schlüssel widerrufen

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

1. Klicken Sie auf das Menü der Taste.
2. Widerrufen auswählen
3. Widerruf bestätigen

Schlüssel regenerieren

Wenn ein Schlüssel kompromittiert wurde:

1. Erstellen Sie einen neuen Schlüssel mit denselben Bereichen.
2. Aktualisieren Sie Ihre Anwendungen
3. Den alten Schlüssel widerrufen

Sicherheits-Best-Practices

Tun

• Speichern Sie Schlüssel in Umgebungsvariablen.
• Verwenden Sie separate Schlüssel für verschiedene Umgebungen.
• Nicht verwendete Schlüssel unverzüglich widerrufen
• Verwenden Sie nur die minimal erforderlichen Bereiche.
• Schlüssel regelmäßig drehen

Nicht

• Commit-Schlüssel zur Versionskontrolle
• Schlüssel zwischen Anwendungen teilen
• Verwenden Sie den Admin-Bereich unnötigerweise.
• Protokollschlüssel in der Anwendungsausgabe
• Schlüssel in clientseitigen Code einbetten

Schlüsselrotation

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

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

Fehlerbehebung

Ungültiger Schlüssel Fehler

Error: Invalid API key

Lösungen:

1. Überprüfen Sie, ob der Schlüssel korrekt kopiert wurde.
2. Überprüfen Sie, ob der Schlüssel nicht widerrufen wurde.
3. Stellen Sie sicher, dass der Schlüssel über die erforderlichen Bereiche verfügt.
4. Überprüfen Sie, ob die Umgebungsvariable gesetzt ist.

Zugriff verweigert

Error: Permission denied for this operation

Lösungen:

1. Überprüfen Sie, ob die erforderlichen Berechtigungen vorhanden sind.
2. Überprüfen Sie, ob Sie der Eigentümer der Ressource sind.
3. Neuen Schlüssel mit korrekten Bereichen erstellen

Ratenbegrenzt

Error: Rate limit exceeded

Lösungen:

1. Anfragehäufigkeit reduzieren
2. Exponentielles Backoff implementieren
3. Wenden Sie sich an den Support, um das Limit zu erhöhen.

FAQ

Wie viele Schlüssel kann ich erstellen?

Es gibt keine feste Begrenzung für API-Schlüssel. Erstellen Sie so viele wie nötig für verschiedene Anwendungen und Umgebungen.

Verfallen Schlüssel?

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

Kann ich meinen Schlüssel nach der Erstellung sehen?

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

Sind Schlüssel regionalspezifisch?

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

Kann ich Schlüssel mit Teammitgliedern teilen?

Bessere Vorgehensweise: Lassen Sie jedes Teammitglied seinen eigenen Schlüssel erstellen. Dies ermöglicht:

• Individuelle Aktivitätsverfolgung
• Selektive Widerrufung
• Ordnungsgemäße Zugangskontrolle

📅 Erstellt vor 0 Tagen ✏️ Aktualisiert vor 0 Tagen

Kommentare