सार्वजनिक सत्यापन

ये एंडपॉइंट सार्वजनिक हैं और इनके लिए प्रमाणीकरण आवश्यक नहीं है। इनकी मदद से कोई भी व्यक्ति बैज credentials का सत्यापन कर सकता है और Open Badge v2.0 JSON डेटा प्राप्त कर सकता है।

सभी एंडपॉइंट https://api.badges.ninja के सापेक्ष हैं।

जारीकर्ता प्राप्त करें

किसी दिए गए जारीकर्ता के लिए Open Badge v2.0 Issuer Profile JSON प्राप्त करें।

GET /certify-badge/issuer/{guid}

उदाहरण

curl https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890

प्रतिक्रिया

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Issuer",
  "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "name": "Acme Academy",
  "url": "https://acme.example.com",
  "email": "badges@acme.example.com",
  "verification": {
    "type": "hosted",
    "allowedOrigins": "api.badges.ninja"
  }
}

---

बैज प्राप्त करें

किसी दिए गए बैज के लिए Open Badge v2.0 BadgeClass JSON प्राप्त करें।

GET /certify-badge/badge/{guid}

उदाहरण

curl https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901

प्रतिक्रिया

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "BadgeClass",
  "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 with a score of 80% or higher"
  },
  "image": "https://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Credential प्राप्त करें

किसी दिए गए credential के लिए Open Badge v2.0 Assertion JSON प्राप्त करें।

GET /certify-badge/award/{guid}

उदाहरण

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012

प्रतिक्रिया

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Assertion",
  "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
  "recipient": {
    "type": "email",
    "hashed": true,
    "identity": "sha256$..."
  },
  "badge": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "issuedOn": "2025-01-15T00:00:00.000Z",
  "verification": {
    "type": "hosted"
  },
  "revoked": false
}

यदि credential रद्द कर दिया गया है, तो assertion में "revoked": true होता है और, कारण दिया गया हो तो, "revocationReason" स्ट्रिंग भी होती है:

{
  "revoked": true,
  "revocationReason": "Issued in error"
}

यह रद्दीकरण का Open Badges 2.0 दृश्य है। वही रद्दीकरण credential के Open Badges 3.0 Verifiable Credential में भी व्यक्त किया जाता है — रद्दीकरण (Bitstring Status List) देखें।

नोट्स

• Open Badge विनिर्देश के अनुसार, गोपनीयता के लिए प्राप्तकर्ता का ईमेल हैश (SHA-256) किया जाता है।
• प्रतिक्रियाएँ 5 मिनट के लिए कैश की जाती हैं (Cache-Control: public, max-age=300)। रद्द किए गए credentials के लिए छोटा 30-सेकंड का कैश (max-age=30) उपयोग होता है ताकि रद्दीकरण जल्दी प्रसारित हो।

---

Credential शेयर टेक्स्ट प्राप्त करें

किसी credential के बैज के लिए कस्टम शेयर टेक्स्ट प्राप्त करें।

GET /certify-badge/award/{guid}/share-text

उदाहरण

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/share-text

प्रतिक्रिया

{
  "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
}

यदि कोई कस्टम शेयर टेक्स्ट सेट नहीं है, तो एक डिफ़ॉल्ट संदेश लौटाया जाता है।

---

Credential ईमेल भेजें (सार्वजनिक)

सार्वजनिक एंडपॉइंट से credential की सूचना वाला ईमेल भेजें। इसका उपयोग सार्वजनिक शेयर पेज द्वारा किया जाता है।

POST /certify-badge/award/{guid}/send-email

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
recipients	string	हाँ	अल्पविराम से अलग किए गए ईमेल पतों की सूची
message	string	नहीं	ईमेल में शामिल करने के लिए कस्टम संदेश

उदाहरण

curl -X POST https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/send-email \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "recipients": "colleague@example.com",
      "message": "Check out this badge!"
    }
  }'

प्रतिक्रिया

{
  "statusCode": 200,
  "info": "award sent"
}

यह एकमात्र एंडपॉइंट है जो अपने परिणाम को { "statusCode", "info" } envelope में लपेटता है। अन्य सभी एंडपॉइंट अपना पेलोड सीधे लौटाते हैं।

---

जारीकर्ता सत्यापित करें

जारीकर्ता के ईमेल पर भेजे गए सत्यापन लिंक पर क्लिक करके जारीकर्ता को सत्यापित करें। इसे आमतौर पर सत्यापन ईमेल के लिंक से खोला जाता है, सीधे कॉल नहीं किया जाता।

GET /certify-badge/verify-issuer/{guid}/{code}

पैरामीटर

पैरामीटर	प्रकार	विवरण
guid	string	जारीकर्ता GUID
code	string	सत्यापन कोड

प्रतिक्रिया

एक HTML पेज लौटाता है जो पुष्टि करता है कि सत्यापन सफल रहा या विफल। यह एंडपॉइंट ब्राउज़र में खोलने के लिए बनाया गया है।