Kimlik Doğrulama

badges.ninja'ya yapılan tüm API istekleri kimlik doğrulaması gerektirir. Bu sayfa, isteklerinizi nasıl doğrulayacağınızı açıklar.

Temel URL

https://api.badges.ninja

Tüm API uç noktaları bu temel URL'ye görelidir.

API Anahtarı ile Kimlik Doğrulama

Birincil kimlik doğrulama yöntemi, X-Api-Key başlığında geçirilen bir API anahtarıdır.

API Anahtarı Alma

Kontrol panelinden:

1. badges.ninja adresinde oturum açın.
2. Kenar çubuğunda API Keys sayfasına gidin.
3. Create API Key düğmesine tıklayın.
4. Anahtarı kopyalayın (yalnızca bir kez gösterilir).

API'den:

API anahtarları, Cognito kimlik doğrulama akışından JWT tokenınızı kullanarak API üzerinden de yönetilebilir. En basit yaklaşım için kontrol paneline bakın.

API Anahtarınızı Kullanma

Her istekte X-Api-Key başlığını ekleyin:

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

API Anahtarı Biçimi

Anahtarlar bws_ önekini kullanır:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

İstek Biçimi

• GET istekleri parametreleri sorgu dizeleri olarak geçirir
• POST ve PUT istekleri, bir parameters nesnesiyle birlikte JSON gövdesi gönderir
• Tüm yanıtlar Content-Type: application/json ile JSON döndürür

POST/PUT İstek Yapısı

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

Örnek İstek

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

Örnek Yanıt

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
  }
}

Hız Sınırları

API istekleri hız sınırlamasına tabidir. Sınırı aşarsanız 429 Too Many Requests yanıtı alırsınız. Birkaç saniye bekleyip yeniden deneyin.

Kamuya Açık Uç Noktalar

Bazı uç noktalar kimlik doğrulaması gerektirmez. Bunlar, /certify-badge/ altındaki, rozet kimlik bilgilerini herkesin doğrulayabildiği kamuya açık doğrulama uç noktalarıdır.