Members API

টিম সিট ও ভূমিকা পরিচালনা করুন — যারা আপনার অ্যাকাউন্টের প্রদানকারী, ব্যাজ ও সনদ ভাগাভাগি করেন।

সমস্ত এন্ডপয়েন্টের জন্য প্রমাণীকরণ প্রয়োজন। দেখুন প্রমাণীকরণ। প্রতিটি অনুরোধ প্রমাণীকৃত মালিকের অ্যাকাউন্টের সাথে সীমাবদ্ধ।

API-এর মাধ্যমে যে ভূমিকাগুলো নির্ধারণ করা যায় সেগুলো হলো admin, editor এবং viewer। owner ভূমিকাটি অ্যাকাউন্ট হোল্ডারের জন্য সংরক্ষিত এবং এটি নির্ধারণ বা সরানো যায় না।

List Members

আপনার অ্যাকাউন্টের সমস্ত সদস্য ও মুলতুবি থাকা আমন্ত্রণ পুনরুদ্ধার করুন।

GET /members

Example

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

Response

{
  "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 সেই আমন্ত্রণগুলোর জন্য যা এখনও গ্রহণ করা হয়নি।

---

Invite Member

ইমেইলের মাধ্যমে একজন ব্যক্তিকে অ্যাকাউন্টে আমন্ত্রণ জানান। একটি অ্যাক্সেপ্ট লিঙ্ক সহ একটি আমন্ত্রণ ইমেইল সেই ঠিকানায় পাঠানো হয়।

POST /members

Parameters

Parameter	Type	Required	Description
email	string	Yes	আমন্ত্রণ জানানোর ইমেইল ঠিকানা (একটি বৈধ ইমেইল হতে হবে)
role	string	Yes	নির্ধারণ করার ভূমিকা — admin, editor, viewer-এর একটি

Example

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

Response

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

Errors

• 400 — role must be one of admin, editor, viewer
• 400 — অবৈধ বা অনুপস্থিত ইমেইল ঠিকানা
• 400 — seat limit reached — প্ল্যানের জন্য অ্যাকাউন্টে কোনো মুক্ত সিট নেই (Free: 2, Starter: 5, Pro: 20, মালিক সহ)। একজন সদস্য সরান বা প্ল্যান আপগ্রেড করুন।
• 400 — ইমেইলটি ইতিমধ্যে একজন সদস্য অথবা এই অ্যাকাউন্টে একটি মুলতুবি থাকা আমন্ত্রণ রয়েছে

---

Accept Invitation

একটি মুলতুবি থাকা আমন্ত্রণ গ্রহণ করুন। প্রমাণীকৃত ব্যবহারকারীর ইমেইল অবশ্যই আমন্ত্রণটি যে ঠিকানায় পাঠানো হয়েছিল তার সাথে মিলতে হবে।

POST /members/accept

Parameters

Parameter	Type	Required	Description
inviteId	string	Yes	অ্যাক্সেপ্ট-লিঙ্ক ইমেইল থেকে প্রাপ্ত আমন্ত্রণ ID

Example

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

Response

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

Errors

• 400 — email does not match invitation — সাইন-ইন করা ইমেইল আমন্ত্রিত ইমেইল থেকে আলাদা
• 404 — আমন্ত্রণ পাওয়া যায়নি (ইতিমধ্যে গৃহীত, বাতিল করা হয়েছে, অথবা inviteId ভুল)

---

Update Member Role

একজন বিদ্যমান সদস্যের ভূমিকা পরিবর্তন করুন। মালিক বা অ্যাডমিন সুবিধা প্রয়োজন।

POST /members/{memberId}/role

Parameters

Parameter	Type	Required	Description
memberId	string	Yes	সদস্য ID (পাথ প্যারামিটার)
role	string	Yes	নতুন ভূমিকা — admin, editor, viewer-এর একটি

Example

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

Response

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

Errors

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — সদস্য পাওয়া যায়নি

---

Remove Member

অ্যাকাউন্ট থেকে একজন সদস্যকে সরান, অথবা একটি মুলতুবি থাকা আমন্ত্রণ বাতিল করুন। সদস্য সঙ্গে সঙ্গেই অ্যাক্সেস হারান এবং তাদের সিট মুক্ত হয়।

DELETE /members/{memberId}

Example

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

Response

একটি সাধারণ স্ট্রিং:

"member has been removed"

Errors

• 400 — the owner cannot be removed
• 404 — সদস্য পাওয়া যায়নি