Badges API

Rozet şablonlarını yönetin — alıcılara verdiğiniz kimlik bilgileri.

Tüm uç noktalar X-Api-Key başlığı aracılığıyla kimlik doğrulaması gerektirir. Kimlik Doğrulama sayfasına bakın.

Rozet Oluşturma

Doğrulanmış bir düzenleyici altında yeni bir rozet oluşturun.

POST /badges

Parametreler

Parametre	Tür	Gerekli	Açıklama
name	string	Evet	Rozet başlığı
description	string	Evet	Rozetin neyi temsil ettiği
criteria	string	Evet	Alıcının bu rozeti kazanmak için ne yaptığı
image	string	Evet	Base64 ile kodlanmış görsel (PNG ya da JPG)
issuerId	string	Evet	Doğrulanmış düzenleyicinin kimliği

Örnek

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

Yanıt

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
  }
}

Notlar

• Rozet oluşturmadan önce düzenleyici doğrulanmış olmalıdır.
• Görsel, kalıcı depolama için IPFS'e yüklenir.

---

Rozetleri Listele

Oluşturduğunuz tüm rozetleri alın.

GET /badges

Örnek

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

Yanıt

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
        "name": "JavaScript Fundamentals",
        "description": "Demonstrates proficiency in core JavaScript concepts",
        "criteria": { "narrative": "Completed the JavaScript Fundamentals course..." },
        "image": "https://ipfs.ninja/ipfs/Qm...",
        "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Rozet Güncelleme

Mevcut bir rozeti güncelleyin. Yalnızca verdiğiniz alanlar değiştirilir.

PUT /badges/{badgeId}

Parametreler

Parametre	Tür	Gerekli	Açıklama
badgeId	string	Evet	Rozet kimliği (yol parametresi)
name	string	Hayır	Yeni rozet başlığı
description	string	Hayır	Yeni açıklama
criteria	string	Hayır	Yeni kriterler
image	string	Hayır	Yeni base64 ile kodlanmış görsel

Örnek

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

Yanıt

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
    "updated": true
  }
}

---

Paylaşım Metnini Güncelle

Alıcılar bu rozeti sosyal medyada paylaştığında görüntülenecek özel metni ayarlayın.

PUT /badges/{badgeId}/share-text

Parametreler

Parametre	Tür	Gerekli	Açıklama
badgeId	string	Evet	Rozet kimliği (yol parametresi)
text	string	Evet	Paylaşım metni (HTML'ye izin verilmez)

Örnek

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

Yanıt

{
  "statusCode": 200,
  "info": {
    "updated": true
  }
}

---

Rozet Silme

Bir rozeti silin. Rozetin hiçbir ödülü bulunmamalıdır.

DELETE /badges/{badgeId}

Örnek

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Yanıt

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Hatalar

• 400 — rozetin ödülleri vardır ve silinemez
• 404 — rozet bulunamadı