Members API

टीम सीटों और भूमिकाओं का प्रबंधन करें — वे लोग जो आपके खाते के जारीकर्ता, बैज और प्रदान साझा करते हैं।

सभी एंडपॉइंट्स के लिए प्रमाणीकरण आवश्यक है। देखें प्रमाणीकरण। हर अनुरोध प्रमाणित स्वामी के खाते तक सीमित होता है।

API के माध्यम से जिन भूमिकाओं को निर्दिष्ट किया जा सकता है वे हैं admin, editor, और viewer। owner भूमिका खाता धारक के लिए आरक्षित है और इसे निर्दिष्ट या हटाया नहीं जा सकता।

सदस्यों की सूची

अपने खाते के सभी सदस्य और लंबित आमंत्रण पुनः प्राप्त करें।

GET /members

उदाहरण

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

प्रतिक्रिया

{
  "items": [
    {
      "memberId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "email": "owner@acme.example.com",
      "role": "owner",
      "status": "active"
    },
    {
      "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "email": "editor@acme.example.com",
      "role": "editor",
      "status": "pending"
    }
  ]
}

status उन सदस्यों के लिए active होता है जिन्होंने स्वीकार कर लिया है, या उन आमंत्रणों के लिए pending जिन्हें अभी तक स्वीकार नहीं किया गया है।

---

सदस्य को आमंत्रित करें

किसी व्यक्ति को ईमेल द्वारा खाते में आमंत्रित करें। पते पर एक स्वीकार लिंक वाला आमंत्रण ईमेल भेजा जाता है।

POST /members

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
email	string	हाँ	आमंत्रित करने के लिए ईमेल पता (एक वैध ईमेल होना चाहिए)
role	string	हाँ	निर्दिष्ट करने के लिए भूमिका — admin, editor, viewer में से एक

उदाहरण

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

प्रतिक्रिया

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "inviteId": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "status": "pending"
}

त्रुटियाँ

• 400 — role must be one of admin, editor, viewer
• 400 — अमान्य या अनुपस्थित ईमेल पता
• 400 — seat limit reached — योजना के लिए खाते में कोई मुफ़्त सीट नहीं है (मुफ़्त: 2, स्टार्टर: 5, प्रो: 20, स्वामी सहित)। किसी सदस्य को हटाएँ या योजना अपग्रेड करें।
• 400 — यह ईमेल पहले से इस खाते पर सदस्य है या इसका लंबित आमंत्रण है

---

आमंत्रण स्वीकार करें

किसी लंबित आमंत्रण को स्वीकार करें। प्रमाणित उपयोगकर्ता का ईमेल उस पते से मेल खाना चाहिए जिस पर आमंत्रण भेजा गया था।

POST /members/accept

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
inviteId	string	हाँ	स्वीकार-लिंक ईमेल से आमंत्रण ID

उदाहरण

curl -X POST https://api.badges.ninja/members/accept \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "inviteId": "c3d4e5f6-a7b8-9012-cdef-123456789012"
    }
  }'

प्रतिक्रिया

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "active"
}

त्रुटियाँ

• 400 — email does not match invitation — साइन-इन किया गया ईमेल आमंत्रित ईमेल से भिन्न है
• 404 — आमंत्रण नहीं मिला (पहले से स्वीकृत, रद्द, या inviteId गलत है)

---

सदस्य भूमिका अपडेट करें

किसी मौजूदा सदस्य की भूमिका बदलें। स्वामी या व्यवस्थापक विशेषाधिकार आवश्यक हैं।

POST /members/{memberId}/role

पैरामीटर

पैरामीटर	प्रकार	आवश्यक	विवरण
memberId	string	हाँ	सदस्य ID (पथ पैरामीटर)
role	string	हाँ	नई भूमिका — admin, editor, viewer में से एक

उदाहरण

curl -X POST https://api.badges.ninja/members/b2c3d4e5-f6a7-8901-bcde-f12345678901/role \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "role": "admin"
    }
  }'

प्रतिक्रिया

{
  "memberId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "role": "admin",
  "updated": true
}

त्रुटियाँ

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — सदस्य नहीं मिला

---

सदस्य को हटाएँ

किसी सदस्य को खाते से हटाएँ, या किसी लंबित आमंत्रण को रद्द करें। सदस्य तुरंत पहुँच खो देता है और उसकी सीट मुक्त हो जाती है।

DELETE /members/{memberId}

उदाहरण

curl -X DELETE https://api.badges.ninja/members/b2c3d4e5-f6a7-8901-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

प्रतिक्रिया

एक सादा स्ट्रिंग:

"member has been removed"

त्रुटियाँ

• 400 — the owner cannot be removed
• 404 — सदस्य नहीं मिला