Kimlik Doğrulama

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

Base URL

https://api.badges.ninja

Tüm API endpoint'leri bu base URL'ye görelidir.

API Anahtarı ile Kimlik Doğrulama

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

API Anahtarı Alma

Panelden:

1. badges.ninja'da oturum açın.
2. Kenar çubuğunda API Keys bölümüne gidin.
3. Create API Key'e tıklayın.
4. Anahtarı kopyalayın (yalnızca bir kez gösterilir).

API üzerinden:

API anahtarları, Cognito kimlik doğrulama akışından aldığınız JWT belirteci kullanılarak API üzerinden de yönetilebilir. En basit yöntem için paneli kullanın.

API Anahtarınızı Kullanma

Her isteğe 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 dizesi olarak iletir
• POST ve PUT istekleri, parameters nesnesi içeren bir 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

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

Herkese Açık Endpoint'ler

Bazı endpoint'ler kimlik doğrulaması gerektirmez. Bunlar, herkesin rozet kimlik bilgilerini doğrulamasına olanak tanıyan /certify-badge/ altındaki herkese açık doğrulama endpoint'leridir.