API Anahtarları

API anahtarları, badges.ninja REST API'sine programatik olarak erişmenizi sağlar. Rozet oluşturma, verme ve yönetme işlemlerini kendi uygulamalarınızdan otomatikleştirmek için kullanın.

API Anahtarı Oluşturma

1. Kenar çubuğundan API Keys sayfasını açın.
2. Create API Key düğmesine tıklayın. Satır içi bir form açılır:

3. Anahtara bir ad verin ve Create düğmesine tıklayın. Anahtarın tamamı yeşil bir bannerda yalnızca bir kez gösterilir:

4. Anahtarı hemen kopyalayın — anahtarın tamamı yalnızca bir kez gösterilir. Kaybederseniz yeni bir tane oluşturmanız gerekir. Banner'ı kapattıktan sonra panel yalnızca anahtarın önekini gösterir (örn. bws_a1b2c3d4...); anahtarın tamamı, isteklerinizin kimliğini doğrulamak için sunucu tarafında saklanır:

Her satır ayrıca anahtarın ne zaman oluşturulduğunu ve kullanıldıysa son kullanım zamanını gösterir; böylece kullanılmayan eski anahtarları fark edebilirsiniz.

Erişim Kapsamları

Bir anahtar oluştururken onu salt okunur yapabilir veya tam erişimli bırakabilirsiniz:

Kapsam	İzin verdikleri
Tam erişim (varsayılan)	Okuma ve yazma — verileri listeleme ile oluşturma, verme, güncelleme veya silme.
Salt okunur	Yalnızca güvenli GET istekleri. Veriyi değiştiren her istek (POST, PUT, PATCH, DELETE) 403 Forbidden ile reddedilir.

Yalnızca verilerinizi okuması gereken entegrasyonlar (raporlama, paneller, yedeklemeler) için salt okunur bir anahtar kullanın; böylece sızan bir anahtar hiçbir şeyi değiştiremez. Oluşturma formunda Read-only key seçeneğini işaretleyin; salt okunur anahtarlar listede Read-only rozeti taşır. Kapsamlar gelmeden önce oluşturulan anahtarlar tam erişimini korur.

Anahtar Biçimi

API anahtarları bws_ önekini ve ardından 32 karakterlik bir onaltılık (hex) dize kullanır:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

İsteklerde API Anahtarlarını Kullanma

API anahtarını her API isteğinin X-Api-Key başlığına ekleyin:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

API kimlik doğrulaması hakkında tüm ayrıntılar için Kimlik Doğrulama sayfasına bakın.

Plana Göre Anahtar Sınırları

Oluşturabileceğiniz API anahtarı sayısı planınıza bağlıdır:

Plan	API Anahtarı Sınırı
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Anahtar Geçerlilik Süresi

Her API anahtarı oluşturulmasından bir yıl sonra sona erer. Bir anahtarın süresi dolduğunda, silinmiş gibi isteklerin kimliğini doğrulamayı bırakır. Kesinti yaşamamak için eski anahtarın süresi dolmadan yeni bir anahtar oluşturun.

Anahtar Silme

1. API Keys sayfasını açın.
2. Silmek istediğiniz anahtarı bulun.
3. Delete düğmesine tıklayın.
4. Silme işlemini onaylayın.

Silindikten sonra anahtar hemen çalışmayı durdurur. Bu anahtarı kullanan tüm uygulamalar kimlik doğrulama hataları alır.