API Anahtarları

API anahtarları, badges.ninja REST API'sine programlı erişim sağlar. Kendi uygulamalarınızdan rozet oluşturmayı, vermeyi ve yönetimi otomatikleştirmek için bunları 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 isim verin ve Create düğmesine tıklayın. Tam anahtar bir kez yeşil bir pankart üzerinde gösterilir:

4. Anahtarı hemen kopyalayın — sadece bir kez gösterilir. Kaybederseniz yenisini oluşturmanız gerekir. Pankartı kapattıktan sonra sadece önek saklanır:

Erişim Kapsamları

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

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

Yalnızca verilerinizi okuması gereken entegrasyonlar (raporlama, kontrol panelleri, yedeklemeler) için salt okunur bir anahtar kullanın; böylece sızdırılan bir anahtar hiçbir şeyi değiştiremez. Oluşturma formunda Read-only key kutusunu işaretleyin; salt okunur anahtarlar listede bir Read-only rozeti gösterir. Kapsamlar var olmadan önce oluşturulan anahtarlar tam erişimi korur.

Anahtar Biçimi

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

İsteklerde API Anahtarları Kullanma

Her API isteğinin X-Api-Key başlığına API anahtarını dahil edin:

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.

Plan Başına 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 Silme

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

Silindikten sonra anahtar hemen çalışmayı durdurur. O anahtarı kullanan uygulamalar kimlik doğrulama hataları alacaktır.