Liikmete API

Halda meeskonnakohti ja rolle — inimesi, kes jagavad sinu konto väljaandjaid, märke ja andmisi.

Kõik lõpp-punktid nõuavad autentimist. Vaata Autentimine. Iga päring on piiratud autenditud omaniku kontoga.

Rollid, mida saab API kaudu määrata, on admin, editor ja viewer. Roll owner on reserveeritud konto omanikule ning seda ei saa määrata ega eemaldada.

Liikmete loendamine

Hangi kõik oma konto liikmed ja ootel kutsed.

GET /members

Näide

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

Vastus

{
  "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 on active liikmete puhul, kes on kutse vastu võtnud, või pending kutsete puhul, mida pole veel vastu võetud.

---

Liikme kutsumine

Kutsu inimene kontole e-posti teel. Aadressile saadetakse kutse e-kiri koos vastuvõtulingiga.

POST /members

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
email	string	Jah	Kutsutav e-posti aadress (peab olema kehtiv e-post)
role	string	Jah	Määratav roll — üks väärtustest admin, editor, viewer

Näide

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

Vastus

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

Vead

• 400 — role must be one of admin, editor, viewer
• 400 — vigane või puuduv e-posti aadress
• 400 — seat limit reached — kontol pole plaani jaoks vabu kohti (Free: 2, Starter: 5, Pro: 20, koos omanikuga). Eemalda liige või täienda plaani.
• 400 — e-post on juba liige või sellel kontol on ootel kutse

---

Kutse vastuvõtmine

Võta vastu ootel kutse. Autenditud kasutaja e-post peab kattuma aadressiga, millele kutse saadeti.

POST /members/accept

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
inviteId	string	Jah	Vastuvõtulingi e-kirjast pärinev kutse ID

Näide

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

Vastus

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

Vead

• 400 — email does not match invitation — sisselogitud e-post erineb kutsutud e-postist
• 404 — kutset ei leitud (juba vastu võetud, tühistatud või inviteId on vale)

---

Liikme rolli muutmine

Muuda olemasoleva liikme rolli. Nõuab omaniku või administraatori õigusi.

POST /members/{memberId}/role

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
memberId	string	Jah	Liikme ID (teeparameeter)
role	string	Jah	Uus roll — üks väärtustest admin, editor, viewer

Näide

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

Vastus

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

Vead

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — liiget ei leitud

---

Liikme eemaldamine

Eemalda liige kontolt või tühista ootel kutse. Liige kaotab kohe juurdepääsu ja tema koht vabaneb.

DELETE /members/{memberId}

Näide

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

Vastus

Paljas sõne:

"member has been removed"

Vead

• 400 — the owner cannot be removed
• 404 — liiget ei leitud