Members API

Pārvaldiet komandas vietas un lomas — cilvēkus, kuri kopīgi izmanto jūsu konta izdevējus, nozīmes un piešķīrumus.

Visiem galapunktiem ir nepieciešama autentifikācija. Skatiet Autentifikācija. Katrs pieprasījums attiecas tikai uz autentificētā īpašnieka kontu.

Lomas, kuras var piešķirt caur API, ir admin, editor un viewer. Loma owner ir rezervēta konta turētājam, un to nevar piešķirt vai noņemt.

Uzskaitīt dalībniekus

Iegūstiet visus dalībniekus un neizskatītos uzaicinājumus jūsu kontā.

GET /members

Piemērs

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

Atbilde

{
  "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 ir active dalībniekiem, kuri ir pieņēmuši uzaicinājumu, vai pending uzaicinājumiem, kuri vēl nav pieņemti.

---

Uzaicināt dalībnieku

Uzaiciniet personu kontā pēc e-pasta. Uz adresi tiek nosūtīts uzaicinājuma e-pasts ar pieņemšanas saiti.

POST /members

Parametri

Parametrs	Tips	Obligāts	Apraksts
email	string	Jā	E-pasta adrese, uz kuru uzaicināt (jābūt derīgam e-pastam)
role	string	Jā	Piešķiramā loma — viena no admin, editor, viewer

Piemērs

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

Atbilde

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

Kļūdas

• 400 — role must be one of admin, editor, viewer
• 400 — nederīga vai trūkstoša e-pasta adrese
• 400 — seat limit reached — kontā nav brīvu vietu plānam (Free: 2, Starter: 5, Pro: 20, ieskaitot īpašnieku). Noņemiet dalībnieku vai jauniniet plānu.
• 400 — e-pasts jau ir dalībnieks vai tam ir neizskatīts uzaicinājums šajā kontā

---

Pieņemt uzaicinājumu

Pieņemiet neizskatītu uzaicinājumu. Autentificētā lietotāja e-pastam jāsakrīt ar adresi, uz kuru tika nosūtīts uzaicinājums.

POST /members/accept

Parametri

Parametrs	Tips	Obligāts	Apraksts
inviteId	string	Jā	Uzaicinājuma ID no pieņemšanas saites e-pasta

Piemērs

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

Atbilde

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

Kļūdas

• 400 — email does not match invitation — piereģistrētais e-pasts atšķiras no uzaicinātā e-pasta
• 404 — uzaicinājums nav atrasts (jau pieņemts, atcelts vai inviteId ir nepareizs)

---

Atjaunināt dalībnieka lomu

Mainiet esoša dalībnieka lomu. Nepieciešamas īpašnieka vai administratora privilēģijas.

POST /members/{memberId}/role

Parametri

Parametrs	Tips	Obligāts	Apraksts
memberId	string	Jā	Dalībnieka ID (ceļa parametrs)
role	string	Jā	Jaunā loma — viena no admin, editor, viewer

Piemērs

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

Atbilde

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

Kļūdas

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — dalībnieks nav atrasts

---

Noņemt dalībnieku

Noņemiet dalībnieku no konta vai atceliet neizskatītu uzaicinājumu. Dalībnieks nekavējoties zaudē piekļuvi, un viņa vieta tiek atbrīvota.

DELETE /members/{memberId}

Piemērs

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

Atbilde

Vienkārša virkne:

"member has been removed"

Kļūdas

• 400 — the owner cannot be removed
• 404 — dalībnieks nav atrasts