Members API

Hallitse tiimipaikkoja ja rooleja — ihmisiä, jotka jakavat tilisi myöntäjät, merkit ja myönnöt.

Kaikki päätepisteet vaativat todennuksen. Katso Todennus. Jokainen pyyntö on rajattu todennetun omistajan tiliin.

Roolit, jotka voidaan määrittää API:n kautta, ovat admin, editor ja viewer. Rooli owner on varattu tilinhaltijalle, eikä sitä voi määrittää tai poistaa.

List Members

Hae kaikki jäsenet ja odottavat kutsut tililtäsi.

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 on active niille jäsenille, jotka ovat hyväksyneet, tai pending kutsuille, joita ei ole vielä hyväksytty.

---

Invite Member

Kutsu henkilö tilille sähköpostilla. Osoitteeseen lähetetään kutsusähköposti, jossa on hyväksymislinkki.

POST /members

Parameters

Parameter	Type	Required	Description
email	string	Yes	Kutsuttava sähköpostiosoite (oltava kelvollinen sähköposti)
role	string	Yes	Määritettävä rooli — jokin arvoista 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 — virheellinen tai puuttuva sähköpostiosoite
• 400 — seat limit reached — tilillä ei ole vapaita paikkoja tilaukselle (Free: 2, Starter: 5, Pro: 20, omistaja mukaan lukien). Poista jäsen tai päivitä tilaus.
• 400 — sähköposti on jo jäsen tai sillä on odottava kutsu tällä tilillä

---

Accept Invitation

Hyväksy odottava kutsu. Todennetun käyttäjän sähköpostin on vastattava osoitetta, johon kutsu lähetettiin.

POST /members/accept

Parameters

Parameter	Type	Required	Description
inviteId	string	Yes	Hyväksymislinkin sähköpostista saatu kutsun tunnus

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 — sisäänkirjautunut sähköposti eroaa kutsutusta sähköpostista
• 404 — kutsua ei löydy (jo hyväksytty, peruutettu tai inviteId on väärä)

---

Update Member Role

Muuta olemassa olevan jäsenen roolia. Vaatii omistajan tai järjestelmänvalvojan oikeudet.

POST /members/{memberId}/role

Parameters

Parameter	Type	Required	Description
memberId	string	Yes	Jäsenen tunnus (polkuparametri)
role	string	Yes	Uusi rooli — jokin arvoista 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 — jäsentä ei löydy

---

Remove Member

Poista jäsen tililtä tai peruuta odottava kutsu. Jäsen menettää pääsyn välittömästi ja hänen paikkansa vapautuu.

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

Pelkkä merkkijono:

"member has been removed"

Errors

• 400 — the owner cannot be removed
• 404 — jäsentä ei löydy