Members API

Spravujte týmová místa a role — lidi, kteří sdílejí vydavatele, odznaky a udělování vašeho účtu.

Všechny koncové body vyžadují ověření. Viz Autentizace. Každý požadavek je omezen na účet ověřeného vlastníka.

Role, které lze přiřadit prostřednictvím API, jsou admin, editor a viewer. Role owner je vyhrazena držiteli účtu a nelze ji přiřadit ani odebrat.

Seznam členů

Získejte všechny členy a čekající pozvánky na vašem účtu.

GET /members

Příklad

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

Odpověď

{
  "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 je active pro členy, kteří pozvánku přijali, nebo pending pro pozvánky, které dosud nebyly přijaty.

---

Pozvat člena

Pozvěte osobu na účet e-mailem. Na adresu se odešle e-mail s pozvánkou obsahující odkaz pro přijetí.

POST /members

Parametry

Parametr	Typ	Povinné	Popis
email	string	Ano	E-mailová adresa k pozvání (musí být platný e-mail)
role	string	Ano	Role k přiřazení — jedna z admin, editor, viewer

Příklad

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

Odpověď

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

Chyby

• 400 — role must be one of admin, editor, viewer
• 400 — neplatná nebo chybějící e-mailová adresa
• 400 — seat limit reached — účet nemá žádná volná místa pro tarif (Free: 2, Starter: 5, Pro: 20, včetně vlastníka). Odeberte člena nebo přejděte na vyšší tarif.
• 400 — tento e-mail už je členem nebo má na tomto účtu čekající pozvánku

---

Přijmout pozvánku

Přijměte čekající pozvánku. E-mail ověřeného uživatele se musí shodovat s adresou, na kterou byla pozvánka odeslána.

POST /members/accept

Parametry

Parametr	Typ	Povinné	Popis
inviteId	string	Ano	ID pozvánky z e-mailu s odkazem pro přijetí

Příklad

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

Odpověď

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

Chyby

• 400 — email does not match invitation — přihlášený e-mail se liší od pozvaného e-mailu
• 404 — pozvánka nenalezena (již přijata, zrušena nebo je inviteId nesprávné)

---

Aktualizovat roli člena

Změňte roli stávajícího člena. Vyžaduje oprávnění vlastníka nebo administrátora.

POST /members/{memberId}/role

Parametry

Parametr	Typ	Povinné	Popis
memberId	string	Ano	ID člena (parametr cesty)
role	string	Ano	Nová role — jedna z admin, editor, viewer

Příklad

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

Odpověď

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

Chyby

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — člen nenalezen

---

Odebrat člena

Odeberte člena z účtu nebo zrušte čekající pozvánku. Člen okamžitě ztrácí přístup a jeho místo se uvolní.

DELETE /members/{memberId}

Příklad

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

Odpověď

Prostý řetězec:

"member has been removed"

Chyby

• 400 — the owner cannot be removed
• 404 — člen nenalezen