Members API

Kezeld a csapathelyeket és szerepköröket — azokat az embereket, akik megosztják a fiókod kibocsátóit, jelvényeit és odaítéléseit.

Minden végpont hitelesítést igényel. Lásd Hitelesítés. Minden kérés a hitelesített tulajdonos fiókjára korlátozódik.

Az API-n keresztül hozzárendelhető szerepkörök: admin, editor és viewer. Az owner szerepkör a fióktulajdonos számára van fenntartva, és nem rendelhető hozzá vagy távolítható el.

Tagok listázása

Kérd le a fiókod összes tagját és függőben lévő meghívóját.

GET /members

Példa

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

Válasz

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

A status értéke active azoknál a tagoknál, akik elfogadták a meghívót, vagy pending a még el nem fogadott meghívóknál.

---

Tag meghívása

Hívj meg egy személyt a fiókba e-mailben. Egy elfogadási hivatkozást tartalmazó meghívó e-mail kerül elküldésre a címre.

POST /members

Paraméterek

Paraméter	Típus	Kötelező	Leírás
email	string	Igen	A meghívandó e-mail-cím (érvényes e-mailnek kell lennie)
role	string	Igen	A hozzárendelendő szerepkör — az admin, editor, viewer egyike

Példa

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

Válasz

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

Hibák

• 400 — role must be one of admin, editor, viewer
• 400 — érvénytelen vagy hiányzó e-mail-cím
• 400 — seat limit reached — a fióknak nincs szabad helye a csomaghoz (Free: 2, Starter: 5, Pro: 20, a tulajdonost is beleértve). Távolíts el egy tagot, vagy válts magasabb csomagra.
• 400 — az e-mail már tag, vagy függőben lévő meghívója van ezen a fiókon

---

Meghívó elfogadása

Fogadj el egy függőben lévő meghívót. A hitelesített felhasználó e-mail-címének egyeznie kell azzal a címmel, amelyre a meghívót küldték.

POST /members/accept

Paraméterek

Paraméter	Típus	Kötelező	Leírás
inviteId	string	Igen	A meghívó azonosítója az elfogadási hivatkozást tartalmazó e-mailből

Példa

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

Válasz

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

Hibák

• 400 — email does not match invitation — a bejelentkezett e-mail eltér a meghívott e-mailtől
• 404 — a meghívó nem található (már elfogadva, visszavonva, vagy az inviteId hibás)

---

Tag szerepkörének frissítése

Módosítsd egy meglévő tag szerepkörét. Tulajdonosi vagy adminisztrátori jogosultságot igényel.

POST /members/{memberId}/role

Paraméterek

Paraméter	Típus	Kötelező	Leírás
memberId	string	Igen	A tag azonosítója (útvonalparaméter)
role	string	Igen	Új szerepkör — az admin, editor, viewer egyike

Példa

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

Válasz

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

Hibák

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — a tag nem található

---

Tag eltávolítása

Távolíts el egy tagot a fiókból, vagy vonj vissza egy függőben lévő meghívót. A tag azonnal elveszíti a hozzáférését, és a helye felszabadul.

DELETE /members/{memberId}

Példa

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

Válasz

Egy egyszerű karakterlánc:

"member has been removed"

Hibák

• 400 — the owner cannot be removed
• 404 — a tag nem található