API Anahtarları#

Ultralytics Platform API anahtarları, uzaktan eğitim, çıkarım ve otomasyon için güvenli programatik erişim sağlar. Farklı kullanım senaryoları için AES-256-GCM şifrelemesine sahip adlandırılmış anahtarlar oluştur.

API Anahtarı Oluştur#

Yeni bir API anahtarı oluştur:

1. Ayarlar > API Anahtarları kısmına git
2. Anahtar Oluştur düğmesine tıkla
3. Anahtar için bir ad gir (ör. "Eğitim Sunucusu")
4. Anahtar Oluştur düğmesine tıkla

Anahtar Adı#

Anahtarına açıklayıcı bir ad ver:

• training-server - Uzaktan eğitim makineleri için
• ci-pipeline - CI/CD entegrasyonu için
• local-dev - Yerel geliştirme için

Anahtar Görüntüleme#

Oluşturulduktan sonra anahtar bir onay iletişim kutusunda görüntülenir:

Anahtar Formatı#

API anahtarları şu formatı izler:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Ön ek (Prefix): ul_, Ultralytics anahtarlarını tanımlar
• Gövde: 40 rastgele onaltılık (hexadecimal) karakter
• Toplam: 43 karakter

Anahtar Güvenliği#

• Anahtarlar düz metin olarak değil, AES-256-GCM şifrelemesi ile saklanır
• İlk 11 karakter (ul_ ve 8 heksadesimal karakter) bir görüntüleme öneki görevi görür, böylece bir anahtar ifşa edilmeden tanımlanabilir

API Anahtarlarını Kullanma#

Ortam Değişkeni#

Anahtarını bir ortam değişkeni olarak ayarla:

export ULTRALYTICS_API_KEY="YOUR_API_KEY"

YOLO CLI#

Anahtarı YOLO CLI kullanarak doğrula ve kaydet:

yolo login YOUR_API_KEY

Kaydedilen anahtarı yolo logout ile kaldır.

HTTP Üstbilgileri#

API isteklerine anahtarı dahil et:

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

Veya bunu Python SDK (pip install "ultralytics-platform>=0.1.5") içine aktar; SDK ayrıca ULTRALYTICS_API_KEY değerini de okur:

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Mevcut tüm uç noktalar için REST API Reference kısmına göz at.

Uzaktan Eğitim#

Anahtarınla metrik akışını etkinleştir.

Başlamadan önce ultralytics paketini kur veya güncelle:

pip install -U ultralytics

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

Eksiksiz uzaktan eğitim kılavuzu için Cloud Training bölümüne bak.

Anahtarları Yönet#

Anahtarları Görüntüle#

Tüm anahtarlar Settings > API Keys sekmesinde listelenir:

Her anahtar kartı; anahtar adını, kopyalanabilir anahtar değerini, göreli oluşturma zamanını ve bir iptal etme düğmesini gösterir.

Anahtarı İptal Et#

Güvenliği tehlikeye girmiş veya artık ihtiyaç duyulmayan bir anahtarı iptal et:

1. API Anahtarları bölümünde anahtarı bul
2. İptal (çöp kutusu) düğmesine tıkla
3. İptali onayla

Anahtarı Yeniden Oluştur#

Bir anahtarın güvenliği tehlikeye girerse:

1. Aynı isimle yeni bir anahtar oluştur
2. Uygulamalarını güncelle
3. Eski anahtarı iptal et

Çalışma Alanı API Anahtarları#

API anahtarları, halihazırda etkin olan çalışma alanına göre kapsamlandırılır:

• Kişisel çalışma alanı: Anahtarlar kişisel hesabın olarak kimlik doğrular
• Takım çalışma alanı: Anahtarlar, bu çalışma alanında tam sahip izinleriyle takım çalışma alanı sahibi olarak kimlik doğrulaması yapar

Kenar çubuğunda çalışma alanları arasında geçiş yaparken API Anahtarları bölümü o çalışma alanına ait anahtarları gösterir. Bir çalışma alanı anahtarı sahip izinleri taşıdığından, bunları yalnızca çalışma alanı sahibi oluşturabilir, görüntüleyebilir veya iptal edebilir. Rol ayrıntıları için Takımlar sayfasına bakın.

Şirket İçi Çalışan Anahtarları#

Bir Şirket İçi ana bilgisayarı bağlamak ayrı bir çalışan anahtarı üretir. Çalışan anahtarları bu sekmeden değil Şirket İçi entegrasyondan yönetilir, API anahtarlarınızla birlikte asla listelenmez ve ana bilgisayarın bağlantısının kesilmesiyle iptal edilir (bu işlem ayrıca o ana bilgisayarın kuyruktaki ve çalışan işlerini de iptal eder).

Güvenlik En İyi Uygulamaları#

Yapılacaklar#

• Anahtarları ortam değişkenlerinde sakla
• Farklı ortamlar için ayrı anahtarlar kullan
• Kullanılmayan anahtarları derhal iptal et
• Anahtarları periyodik olarak döndür
• Anahtar amaçlarını tanımlamak için açıklayıcı adlar kullan

Yapılmayacaklar#

• Anahtarları sürüm kontrolüne kaydetme (commit etme)
• Anahtarları uygulamalar arasında paylaşma
• Anahtarları uygulama çıktısında günlüğe kaydetme
• Anahtarları istemci tarafı koduna gömme

Anahtar Döndürme#

Güvenlik için anahtarları periyodik olarak döndür:

1. Aynı isimle yeni anahtar oluştur
2. Yeni anahtarı kullanmak için uygulamaları güncelle
3. Uygulamaların doğru çalıştığını doğrula
4. Eski anahtarı iptal et

Sorun Giderme#

Geçersiz Anahtar Hatası#

Error: Invalid API key

Çözümler:

1. Anahtarın doğru şekilde kopyalandığını doğrula (ul_ ön eki dahil)
2. Anahtarın iptal edilmediğini kontrol et
3. Ortam değişkeninin ayarlandığını onayla
4. ultralytics>=8.4.120 kullandığından emin ol

Erişim Reddedildi#

Error: Permission denied for this operation

Çözümler:

1. Kaynak sahibi olduğunu veya uygun çalışma alanı erişimine sahip olduğunu doğrula
2. Anahtarın doğru çalışma alanına ait olup olmadığını kontrol et
3. Anahtarları bir takım çalışma alanında yönetiyorsan, çalışma alanı sahibi olduğundan emin ol; diğer roller Workspace owner access required alır
4. Gerekirse yeni bir anahtar oluştur

Hız Sınırına Takıldı (Rate Limited)#

Error: Rate limit exceeded

Çözümler:

1. İstek sıklığını azaltın; kategori bazındaki sınırlar için oran sınırı tablosuna bakın
2. Retry-After üst bilgisini (header) kullanarak üstel tabanlı artan bekleme süresi (exponential backoff) uygula
3. İzole çıkarım kapasitesine ihtiyaç duyduğunda dedicated endpoint kullan

SSS#