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 amaçları için AES-256-GCM şifrelemesiyle adlandırılmış anahtarlar oluştur.

API Anahtarı Oluştur#

Yeni bir API anahtarı oluştur:

1. Ayarlar > API Anahtarları'na git
2. Anahtar Ekle'ye tıkla ve sağlayıcı olarak Ultralytics'i seç
3. Anahtar için bir ad gir (ör. "Eğitim Sunucusu")
4. Anahtar Oluştur'a 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ın Görüntülenmesi#

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

Agent'lar ve Anotasyon için Sağlayıcı Anahtarları#

Aynı Ayarlar > API Anahtarları sekmesinde, Agent'lar tarafından ve sınıf istemli anotasyon içindeki ücretli modeller tarafından kullanılan harici model sağlayıcılarının anahtarları da saklanır; anotasyon, veri kümesinin çalışma alanında kayıtlı anahtarı kullanır. Bu anahtarları yalnızca çalışma alanı sahibi ekleyebilir, değiştirebilir veya kaldırabilir; ekip üyeleri hangi sağlayıcıların bağlı olduğunu görebilir. Bağlı olmayan bir sağlayıcı için sahibinden bağlantı kurmasını iste. Sağlayıcıyı çalışma alanı sahibi olarak bağlamak için:

1. Anahtar Ekle'ye tıkla.
2. İş akışının dil veya görsel-dil modeliyle ya da çalıştırmak istediğin anotasyon modeliyle eşleşen sağlayıcıyı seç.
3. Sağlayıcının API anahtarını API Anahtarı alanına yapıştır, ardından Anahtarı Kaydet'e tıkla. İletişim kutusundaki API anahtarı al bağlantısı sağlayıcının anahtar sayfasını açar.

Ultralytics anahtarı, harici model sağlayıcılarında kimlik doğrulaması yapmaz. Sağlayıcı kullanımı, kaydedilen anahtarla ilişkili sağlayıcı hesabı üzerinden faturalandırılır. Sağlayıcı anahtarını değiştirmek için anahtar satırındaki düzenleme kontrolünü kullan.

Anahtar Biçimi#

API anahtarları şu biçimdedir:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Önek: ul_, Ultralytics anahtarlarını tanımlar
• Gövde: 40 rastgele onaltılık karakter
• Toplam: 43 karakter

Anahtar Güvenliği#

• Anahtarlar hiçbir zaman düz metin olarak değil, AES-256-GCM şifrelemesiyle saklanır
• İlk 11 karakter (ul_ ve 8 onaltılık karakter), anahtarı açığa çıkarmadan tanımlamaya yarayan bir görüntüleme öneki olarak kullanılır

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#

Python>=3.11 üzerinde YOLO CLI kullanarak anahtarı doğrula ve kaydet:

yolo login YOUR_API_KEY

Kaydedilen anahtarı yolo logout ile kaldır.

HTTP Üst Bilgileri#

Anahtarı API isteklerine ekle:

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

Ya da anahtarı, Python SDK'ya (pip install "ultralytics-platform>=0.1.45") ilet; api_key belirtilmediğinde SDK ULTRALYTICS_API_KEY değerini veya yolo login ile kaydedilen anahtarı okur:

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Kullanılabilir tüm uç noktalar için REST API Referansı sayfasına bak.

Uzaktan Eğitim#

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

Başlamadan önce Ultralytics paketini Python>=3.11 üzerinde 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

Uzaktan eğitim kılavuzunun tamamı için Bulut Eğitimi sayfasına bak.

Anahtarları Yönet#

Anahtarları Görüntüle#

Tüm anahtarlar Settings > API Keys sekmesinde listelenir:

Her anahtar satırında anahtarın adı, öneki, oluşturulma tarihi, anahtarın tamamını kopyalamak için bir düğme ve kaldırma (çöp kutusu) düğmesi bulunur.

Anahtarı İptal Et#

Ele geçirilmiş veya artık gerekmeyen bir anahtarı iptal et:

1. API Anahtarları bölümünde anahtarı bul
2. Kaldırma (çöp kutusu) düğmesine tıkla
3. Onaylamak için Anahtarı Kaldır'a tıkla

Anahtarı Yeniden Oluştur#

Bir anahtar ele geçirilirse:

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

Çalışma Alanı API Anahtarları#

API anahtarları, o anda etkin olan çalışma alanıyla sınırlıdır:

• Kişisel çalışma alanı: Anahtarlar kişisel hesabın olarak kimlik doğrulaması yapar
• Ekip çalışma alanı: Anahtarlar, çalışma alanında tüm sahip izinleriyle ekip çalışma alanı sahibi olarak kimlik doğrulaması yapar

Kenar çubuğunda çalışma alanları arasında geçiş yaptığında, API Anahtarları bölümünde ilgili çalışma alanının anahtarları gösterilir. Çalışma alanı anahtarı sahip izinleri taşıdığından, anahtarı yalnızca çalışma alanı sahibi oluşturabilir, görüntüleyebilir veya iptal edebilir. Rol ayrıntıları için Ekipler sayfasına bak.

Yerinde Çalışan Anahtarları#

Bir Yerinde ana makine bağlandığında ayrı bir çalışan anahtarı oluşturulur. Çalışan anahtarları bu sekmeden değil, Yerinde entegrasyonundan yönetilir; API anahtarlarının yanında hiçbir zaman listelenmez ve ana makinenin bağlantısı kesilerek iptal edilir. Bu işlem ayrıca söz konusu ana makinenin sıraya alınmış ve çalışmakta olan işlerini iptal eder.

Güvenlik için En İyi Uygulamalar#

Yapılması gerekenler#

• Anahtarları ortam değişkenlerinde sakla
• Farklı ortamlar için ayrı anahtarlar kullan
• Kullanılmayan anahtarları hemen iptal et
• Anahtarları düzenli olarak yenile
• Anahtarların kullanım amaçlarını belirlemek için açıklayıcı adlar kullan

Yapma#

• Anahtarları sürüm kontrolüne kaydetme
• Anahtarları uygulamalar arasında paylaşma
• Anahtarları uygulama çıktısına yazdırma
• Anahtarları istemci tarafı koda gömme

Anahtar Rotasyonu#

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

1. Aynı adla yeni bir anahtar oluştur
2. Uygulamaları yeni anahtarı kullanacak şekilde 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 kopyalandığını doğrula (ul_ öneki dâhil)
2. Anahtarın iptal edilmediğini kontrol et
3. Ortam değişkeninin ayarlandığını doğrula
4. Python>=3.11 ve ultralytics>=8.4.120 kullandığından emin ol

İzin Reddedildi#

Error: Permission denied for this operation

Çözümler:

1. Kaynağın 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 olduğunu kontrol et
3. Bir ekip çalışma alanındaki anahtarları yönetiyorsan çalışma alanı sahibi olduğunu doğrula — diğer roller Workspace owner access required alır
4. Gerekirse yeni bir anahtar oluştur

İstek Sınırı Aşıldı#

Error: Rate limit exceeded

Çözümler:

1. İstek sıklığını azalt — kategori başına sınırlar için istek sınırı tablosuna bak
2. Retry-After başlığını kullanarak üstel geri çekilme uygula
3. Yalıtılmış çıkarım kapasitesine ihtiyacın olduğunda özel bir uç nokta kullan

Sık Sorulan Sorular#