जारीकर्ता API

बैज जारीकर्ताओं को प्रबंधित करें — वे संगठन या व्यक्ति जो बैज जारी करते हैं।

सभी एंडपॉइंट के लिए X-Api-Key हेडर के माध्यम से प्रमाणीकरण आवश्यक है। प्रमाणीकरण देखें।

जारीकर्ता बनाएँ

एक नया बैज जारीकर्ता बनाएँ।

POST /issuers

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
name	string	हाँ	संगठन का नाम (कम से कम 3 वर्ण)
url	string	हाँ	संगठन की वेबसाइट (वैध HTTP/HTTPS URL होना चाहिए)
email	string	हाँ	जारीकर्ता का संपर्क ईमेल
logo	string	नहीं	Base64-एन्कोडेड छवि (PNG या JPG)
linkedinOrganizationId	string	नहीं	LinkedIn कंपनी पेज की संख्यात्मक ID। सेट होने पर, इस जारीकर्ता के हर सार्वजनिक credential पेज पर Add to LinkedIn Profile बटन दिखता है।

उदाहरण

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com"
    }
  }'

प्रतिक्रिया

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

टिप्पणियाँ

• यह आपके प्लान की जारीकर्ता सीमा में गिना जाता है (Free: 2, Starter: 5, Pro: 10)। कोई कोटा नहीं कटता।
• यदि जारीकर्ता का ईमेल आपके खाते के ईमेल से मेल खाता है, तो जारीकर्ता स्वतः सत्यापित हो जाता है।
• यदि ईमेल अलग है, तो जारीकर्ता के ईमेल पर एक सत्यापन ईमेल भेजा जाता है।
• जारीकर्ता को कॉन्फ़िगर करने के बाद, उस जारीकर्ता के अंतर्गत credentials जारी करना शुरू करने के लिए Credentials API का उपयोग करें।

---

जारीकर्ताओं की सूची

आपके द्वारा बनाए गए सभी जारीकर्ताओं को प्राप्त करें।

GET /issuers

उदाहरण

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

प्रतिक्रिया

{
  "items": [
    {
      "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com",
      "verified": true,
      "timestamp": 1736937000000
    }
  ]
}

timestamp मिलीसेकंड में Unix epoch है। जब जारीकर्ता एक पेज में समा सकने से अधिक हों, तो पेजिनेशन के लिए lastEvaluatedKey भी लौटाया जाता है।

---

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

जारीकर्ता के ईमेल पर भेजे गए सत्यापन कोड से उसे सत्यापित करें।

POST /issuers/{issuerId}/verify

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
issuerId	string	हाँ	जारीकर्ता ID (पाथ पैरामीटर)
code	string	हाँ	ईमेल से मिला सत्यापन कोड

उदाहरण

curl -X POST https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/verify \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "ABC123"
    }
  }'

प्रतिक्रिया

एक सादा string:

"issuer has been verified"

---

जारीकर्ता हटाएँ

एक जारीकर्ता को हटाएँ। जारीकर्ता से कोई बैज जुड़ा नहीं होना चाहिए।

DELETE /issuers/{issuerId}

उदाहरण

curl -X DELETE https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Api-Key: bws_your_api_key_here"

प्रतिक्रिया

एक सादा string:

"issuer has been deleted"

त्रुटियाँ

• 400 — जारीकर्ता से अभी भी बैज जुड़े हैं: issuer has {n} badge(s) linked — delete the badges first। हटाना केवल जुड़े बैज पर निर्भर है — credentials इसे नहीं रोकते।
• 404 — जारीकर्ता नहीं मिला

---

जारीकर्ता अपडेट करें

जारीकर्ता के फ़ील्ड अपडेट करें। केवल असत्यापित जारीकर्ता संपादित किए जा सकते हैं — जारीकर्ता के सत्यापित होने के बाद, credential की स्थिरता बनाए रखने के लिए यह एंडपॉइंट 400 verified issuers cannot be edited लौटाता है। जारीकर्ता को संपादित करने से उसका सत्यापन कोड फिर से बनता है: यदि email आपके खाते के ईमेल से मेल खाता है तो जारीकर्ता स्वतः फिर से सत्यापित हो जाता है, अन्यथा उस पते पर नया सत्यापन ईमेल भेजा जाता है।

PUT /issuers/{issuerId}

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
issuerId	string	हाँ	जारीकर्ता ID (पाथ पैरामीटर)
name	string	नहीं	नया नाम
url	string	नहीं	नया URL
email	string	नहीं	नया ईमेल (यदि यह आपके खाते के ईमेल से मेल नहीं खाता तो नया सत्यापन मेल भेजता है)
logo	string	नहीं	नया base64-एन्कोडेड लोगो
linkedinOrganizationId	string	नहीं	नई LinkedIn संगठन ID (या हटाने के लिए खाली string)

प्रतिक्रिया

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "updated": true
}

त्रुटियाँ

• 400 — verified issuers cannot be edited (जारीकर्ता पहले से सत्यापित है)
• 400 — not authorized (जारीकर्ता किसी अन्य खाते का है)
• 404 — जारीकर्ता नहीं मिला