Issuers 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। जब सेट हो, तो इस जारीकर्ता से प्रत्येक सार्वजनिक अवॉर्ड पृष्ठ एक 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"
    }
  }'

प्रतिक्रिया

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

टिप्पणियाँ

• आपके प्लान की जारीकर्ता सीमा के विरुद्ध गिना जाता है (Free: 1, Starter: 5, Pro: असीमित)। कोई कोटा कटौती नहीं।
• यदि जारीकर्ता का ईमेल आपके खाते के ईमेल से मेल खाता है, तो जारीकर्ता स्वतः सत्यापित होता है।
• यदि ईमेल भिन्न है, तो जारीकर्ता ईमेल पर एक सत्यापन ईमेल भेजा जाता है।

---

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

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

GET /issuers

उदाहरण

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

प्रतिक्रिया

{
  "statusCode": 200,
  "info": {
    "issuers": [
      {
        "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": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

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

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

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

प्रतिक्रिया

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

---

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

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

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"

प्रतिक्रिया

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

त्रुटियाँ

• 400 — जारीकर्ता के पास बैज या अवॉर्ड हैं और हटाया नहीं जा सकता (पहले उन्हें हटाएँ)
• 404 — जारीकर्ता नहीं मिला

---

जारीकर्ता अद्यतन करें

एक असत्यापित जारीकर्ता के फ़ील्ड अद्यतन करें। एक बार जारीकर्ता सत्यापित हो जाने पर, क्रेडेंशियल स्थिरता बनाए रखने के लिए केवल logo और linkedinOrganizationId संपादन योग्य रहते हैं।

PUT /issuers/{issuerId}

पैरामीटर

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

---

सत्यापन कोड रोटेट करें

पिछले सत्यापन लिंक को अमान्य करें और एक नया ईमेल करें। केवल तब मान्य है जब जारीकर्ता अभी भी असत्यापित है।

POST /issuers/{issuerId}/rotate-code

प्रतिक्रिया

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