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 durumları 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ı kısmına git
2. Anahtar Oluştur düğmesine tıkla
3. Anahtar için bir isim gir (örneğin, "Eğitim Sunucusu")
4. Anahtar Oluştur düğmesine tıkla

Anahtar Adı

Anahtarına açıklayıcı bir isim 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 kez görüntülenir:

Anahtar Formatı

API anahtarları şu formatı izler:

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

Anahtar Güvenliği

• Anahtarlar AES-256-GCM şifreleme ile saklanır
• Kimlik doğrulama, hızlı önek arama ve karma karşılaştırması için SHA-256 karmasını kullanır
• Tam anahtar değerleri asla düz metin (plaintext) olarak saklanmaz

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 ayarla:

yolo settings api_key="YOUR_API_KEY"

Kod İçinde

Anahtarı Python betiklerinde kullan:

import os

# From environment (recommended)
api_key = os.environ.get("ULTRALYTICS_API_KEY")

# Or directly (not recommended for production)
api_key = "YOUR_API_KEY"

HTTP Başlıkları

Anahtarı API isteklerine dahil et:

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

Tüm mevcut uç noktalar için REST API Referansı bölümüne bak.

Uzaktan Eğitim

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

pip install "ultralytics>=8.4.35"

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 Bulut Eğitimi sayfasına bak.

Anahtarları Yönet

Anahtarları Görüntüle

All keys are listed on the Settings > API Keys tab:

Her anahtar kartı; anahtar adını, tam deşifre edilmiş anahtar değerini (kopyalanabilir), göreceli oluşturma zamanını ve bir iptal etme düğmesini gösterir.

Anahtarı İptal Et

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

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

Anahtarı Yeniden Oluştur

Eğer bir anahtar ele geçirilmişse:

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ı, o anda 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
• Ekip çalışma alanı: Anahtarlar ekip bağlamında kimlik doğrular

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. Çalışma alanı API anahtarlarını yönetmek için Düzenleyici rolü veya daha üstü gereklidir. Rol detayları için Ekipler bölümüne bak.

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ı belirlemek için açıklayıcı isimler kullan

Yapılmayacaklar

• Anahtarları sürüm kontrol sistemine (version control) işleme
• Anahtarları uygulamalar arasında paylaşma
• Anahtarları uygulama çıktılarına kaydetme (loglama)
• Anahtarları istemci tarafı (client-side) 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. 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ı

Çözümler:

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

Erişim Reddedildi

Çö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. Gerekirse yeni bir anahtar oluştur

Hız Sınırı Aşıldı

Çözümler:

1. İstek sıklığını azalt — uç nokta başına limitler için hız sınırı tablosuna bak
2. Retry-After başlığını kullanarak üstel geri çekilme (exponential backoff) uygula
3. Sınırsız çıkarım hacmi için özel bir uç nokta kullan

SSS

Kaç tane anahtar oluşturabilirim?

API anahtarları üzerinde kesin bir sınır yoktur. Farklı uygulamalar ve ortamlar için ihtiyaç duyduğun kadar çok anahtar oluştur.

Anahtarların süresi dolar mı?

Anahtarlar otomatik olarak sona ermez. İptal edilene kadar geçerli kalırlar. Güvenlik için anahtar rotasyonunu uygulamayı düşün.

Oluşturduktan sonra anahtarımı görebilir miyim?

Evet, tam anahtar değerleri Settings > API Keys kısmındaki anahtar listesinde görünür. Platform, anahtarlarını dilediğin zaman kopyalayabilmen için şifresini çözer ve görüntüler.

Anahtarlar bölgeye özel mi?

Anahtarlar bölgeler arasında çalışır ancak yalnızca hesabının bulunduğu bölgedeki verilere erişim sağlar.

Anahtarları ekip üyeleriyle paylaşabilir miyim?

Daha iyi uygulama: Her ekip üyesinin kendi anahtarını oluşturmasını sağla. Ekip çalışma alanları için, Editör rolüne veya daha yüksek bir role sahip her üye, o çalışma alanına özel anahtarlar oluşturabilir.