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 — बैज नहीं मिला