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 alanları için AES-256-GCM şifrelemeli, adlandırılmış anahtarlar oluştur.

API Anahtarı Oluştur#

Yeni bir API anahtarı oluştur:

1. Ayarlar > API Anahtarları bölümüne git
2. Add Key öğesine tıkla ve sağlayıcı olarak Ultralytics seçeneğini seç
3. Anahtar için bir ad gir (ör. "Eğitim Sunucusu")
4. Anahtar Oluştur seçeneğine 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:

Ajanlar için Sağlayıcı Anahtarları#

Aynı Settings > API Keys sekmesi, Agents tarafından kullanılan harici model sağlayıcılarına ait anahtarları da depolar. Yalnızca çalışma alanı sahibi bu anahtarları ekleyebilir, değiştirebilir veya kaldırabilir; ekip üyeleri hangi sağlayıcıların bağlı olduğunu görebilir. Eksik bir sağlayıcıyı bağlamasını sahibinden iste. Sağlayıcıyı sahibi olarak bağlamak için:

1. Add Key öğesine tıkla.
2. İş akışının dil veya vizyon-dil modeline uyan sağlayıcıyı seç.
3. Bu sağlayıcının API anahtarını API Key alanına yapıştır, ardından Save Key öğesine tıkla. İletişim kutusunun Get an API key bağlantısı, sağlayıcının anahtar sayfasını açar.

Bir Ultralytics anahtarı harici model sağlayıcılarının kimliğini doğrulamaz. Sağlayıcı kullanımı, kaydedilen anahtarla ilişkilendirilen sağlayıcı hesabı üzerinden faturalandırılır. Bir sağlayıcı anahtarını değiştirmek için anahtar satırının düzenleme denetimini kullan.

Anahtar Biçimi#

API anahtarları şu biçimi izler:

ul_a1b2c3d4e5f60718293a4b5c6d7e8f90a1b2c3d4

• Ön ek: 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 şifrelemesi ile saklanır
• İlk 11 karakter (ul_ ve 8 onaltılık karakter), anahtarın kendisini açığa çıkarmadan tanımlanabilmesi için görüntüleme ön eki 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

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

Veya bunu ULTRALYTICS_API_KEY okuyan veya api_key atlandığında yolo login tarafından kaydedilen anahtarı okuyan Python SDK (pip install "ultralytics-platform>=0.1.45") içine aktar:

from ultralytics_platform import Platform

client = Platform(api_key="YOUR_API_KEY")

Kullanılabilir tüm uç noktalar için REST API Reference bölümüne bak.

Uzak Eğitim#

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

Başlamadan önce Python>=3.11 üzerinde 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ında anahtar adı, kopyalanabilir anahtar değeri, göreli oluşturulma zamanı ve bir iptal düğmesi gösterilir.

Anahtarı İptal Et#

Güvenliği ihlal edilmiş veya artık gerekli olmayan bir anahtarı iptal et:

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

Anahtarı Yeniden Oluştur#

Bir anahtarın güvenliği ihlal edildiyse:

1. Aynı ada sahip 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, ekip çalışma alanı sahibi olarak kimlik doğrulaması yapar ve bu çalışma alanında tam sahip izinlerine sahip olur

Kenar çubuğunda çalışma alanları arasında geçiş yaptığında API Anahtarları bölümü, o çalışma alanına ait anahtarları gösterir. Bir çalışma alanı anahtarı sahip izinlerini 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 Teams bölümüne bak.

On Premise Worker Anahtarları#

Bir On Premise ana bilgisayarını bağlamak, ayrı bir worker anahtarı oluşturur. Worker anahtarları bu sekme yerine On Premise entegrasyonundan yönetilir, API anahtarlarının yanında hiçbir zaman listelenmez ve ana bilgisayarın bağlantısı kesilerek iptal edilir — bu işlem, ana bilgisayarın kuyruğa alınmış ve çalışmakta olan işlerini de iptal eder.

Güvenlik İçin En İyi Uygulamalar#

Yap#

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

Yapma#

• Anahtarları sürüm denetimine gönderme
• Anahtarları uygulamalar arasında paylaşma
• Anahtarları uygulama çıktısına yazma
• Anahtarları istemci tarafı koduna gömme

Anahtar Döndürme#

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

1. Aynı ada sahip 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 (ul_ ön eki dahil) doğru kopyalandığını doğrula
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. 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 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 iletisini alır
4. Gerekirse yeni bir anahtar oluştur

İstek Hızı Sınırlandı#

Error: Rate limit exceeded

Çözümler:

1. İstek sıklığını azalt — kategori başına sınırlar için rate limit table bölümüne bak
2. Retry-After üst bilgisini kullanarak üstel geri çekilme uygula
3. Yalıtılmış çıkarım kapasitesine ihtiyaç duyduğunda özel bir uç nokta kullan

SSS#