Members API

Pamahalaan ang mga upuan ng koponan at papel — ang mga taong nagbabahagi ng mga tagapaglabas, badge, at pagbibigay ng iyong account.

Lahat ng endpoint ay nangangailangan ng pagpapatunay. Tingnan ang Pagpapatunay. Bawat kahilingan ay saklaw sa account ng napatunayang owner.

Ang mga papel na maaaring i-assign sa pamamagitan ng API ay admin, editor, at viewer. Ang papel na owner ay nakalaan para sa may-hawak ng account at hindi maaaring i-assign o alisin.

List Members

Kunin ang lahat ng miyembro at nakabinbing mga imbitasyon sa iyong account.

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

Ang status ay active para sa mga miyembrong tumanggap na, o pending para sa mga imbitasyong hindi pa tinatanggap.

---

Invite Member

Mag-imbita ng isang tao sa account sa pamamagitan ng email. Ang isang email ng imbitasyon na may accept link ay ipinapadala sa address.

POST /members

Parameters

Parameter	Type	Required	Description
email	string	Yes	Email address na iimbitahan (dapat isang wastong email)
role	string	Yes	Papel na iaassign — isa sa 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 — hindi wasto o kulang na email address
• 400 — seat limit reached — walang libreng upuan ang account para sa plano (Free: 2, Starter: 5, Pro: 20, kasama ang owner). Mag-alis ng miyembro o mag-upgrade ng plano.
• 400 — ang email ay miyembro na o may nakabinbing imbitasyon sa account na ito

---

Accept Invitation

Tanggapin ang isang nakabinbing imbitasyon. Ang email ng napatunayang user ay dapat tumugma sa address kung saan ipinadala ang imbitasyon.

POST /members/accept

Parameters

Parameter	Type	Required	Description
inviteId	string	Yes	Ang invitation ID mula sa email ng accept link

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 — ang naka-sign in na email ay iba sa inimbitahang email
• 404 — hindi natagpuan ang imbitasyon (tinanggap na, kinansela, o mali ang inviteId)

---

Update Member Role

Baguhin ang papel ng isang umiiral na miyembro. Nangangailangan ng pribilehiyo ng owner o admin.

POST /members/{memberId}/role

Parameters

Parameter	Type	Required	Description
memberId	string	Yes	Ang member ID (path parameter)
role	string	Yes	Bagong papel — isa sa 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 — hindi natagpuan ang miyembro

---

Remove Member

Mag-alis ng miyembro sa account, o kanselahin ang isang nakabinbing imbitasyon. Agad na nawawalan ng akses ang miyembro at napapalaya ang kanilang upuan.

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

Isang payak na string:

"member has been removed"

Errors

• 400 — the owner cannot be removed
• 404 — hindi natagpuan ang miyembro