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

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

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

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

एक दिए गए जारीकर्ता के लिए Open Badge v2.0 जारीकर्ता प्रोफ़ाइल 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://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

अवॉर्ड प्राप्त करें

एक दिए गए अवॉर्ड के लिए Open Badge v2.0 असर्शन 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"
  }
}

टिप्पणियाँ

• प्राप्तकर्ता का ईमेल Open Badge स्पेक के अनुसार गोपनीयता के लिए हैश (SHA-256) किया गया है।
• प्रतिक्रियाएँ 1 घंटे के लिए कैश की जाती हैं (Cache-Control: public, max-age=3600)।

---

अवॉर्ड शेयर टेक्स्ट प्राप्त करें

एक अवॉर्ड के बैज के लिए कस्टम शेयर टेक्स्ट प्राप्त करें।

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

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

---

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

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

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

पैरामीटर

पैरामीटर	प्रकार	अनिवार्य	विवरण
recipients	string	हाँ	ईमेल पतों की कॉमा-पृथक सूची
subject	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"
}

---

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

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

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

पैरामीटर

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

प्रतिक्रिया

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