Badges API

ব্যাজ টেমপ্লেট পরিচালনা করুন — যে ক্রেডেনশিয়ালগুলি আপনি প্রাপকদের প্রদান করেন।

সমস্ত এন্ডপয়েন্টের জন্য X-Api-Key হেডারের মাধ্যমে প্রমাণীকরণ প্রয়োজন। প্রমাণীকরণ দেখুন।

ব্যাজ তৈরি করা

একটি যাচাইকৃত ইস্যুয়ারের অধীনে একটি নতুন ব্যাজ তৈরি করুন।

POST /badges

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
name	string	হ্যাঁ	ব্যাজ শিরোনাম
description	string	হ্যাঁ	ব্যাজটি কী প্রতিনিধিত্ব করে
criteria	string	হ্যাঁ	প্রাপক এই ব্যাজ অর্জন করতে কী করেছে
image	string	হ্যাঁ	Base64-এনকোডেড ছবি (PNG বা JPG)
issuerId	string	হ্যাঁ	যাচাইকৃত ইস্যুয়ারের ID

উদাহরণ

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"
    }
  }'

প্রতিক্রিয়া

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

নোট

• ব্যাজ তৈরির আগে ইস্যুয়ার যাচাই করা হতে হবে।
• ছবি স্থায়ী স্টোরেজের জন্য IPFS-এ আপলোড হয়।

---

ব্যাজ তালিকা

আপনার তৈরি করা সমস্ত ব্যাজ পুনরুদ্ধার করুন।

GET /badges

উদাহরণ

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

প্রতিক্রিয়া

{
  "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"
      }
    ]
  }
}

---

ব্যাজ আপডেট

একটি বিদ্যমান ব্যাজ আপডেট করুন। শুধুমাত্র আপনি যে ক্ষেত্রগুলি সরবরাহ করেন সেগুলি পরিবর্তন হয়।

PUT /badges/{badgeId}

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
badgeId	string	হ্যাঁ	ব্যাজ ID (পথ প্যারামিটার)
name	string	না	নতুন ব্যাজ শিরোনাম
description	string	না	নতুন বিবরণ
criteria	string	না	নতুন মানদণ্ড
image	string	না	নতুন base64-এনকোডেড ছবি

উদাহরণ

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"
    }
  }'

প্রতিক্রিয়া

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

---

শেয়ার টেক্সট আপডেট

প্রাপকরা যখন সোশ্যাল মিডিয়ায় এই ব্যাজ শেয়ার করেন তখন প্রদর্শিত কাস্টম টেক্সট সেট করুন।

PUT /badges/{badgeId}/share-text

প্যারামিটার

প্যারামিটার	প্রকার	প্রয়োজনীয়	বিবরণ
badgeId	string	হ্যাঁ	ব্যাজ ID (পথ প্যারামিটার)
text	string	হ্যাঁ	শেয়ার টেক্সট (কোনো HTML অনুমোদিত নয়)

উদাহরণ

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:"
    }
  }'

প্রতিক্রিয়া

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

---

ব্যাজ মুছে ফেলুন

একটি ব্যাজ মুছুন। ব্যাজের কোনো অ্যাওয়ার্ড থাকা উচিত নয়।

DELETE /badges/{badgeId}

উদাহরণ

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

প্রতিক্রিয়া

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

ত্রুটি

• 400 — ব্যাজের অ্যাওয়ার্ড আছে এবং মুছে ফেলা যাবে না
• 404 — ব্যাজ পাওয়া যায়নি