Members API

Administrer teamplasser og roller — personene som deler kontoens utstedere, merker og tildelinger.

Alle endepunkter krever autentisering. Se Autentisering. Hver forespørsel er avgrenset til den autentiserte eierens konto.

Roller som kan tildeles via API-et er admin, editor og viewer. owner-rollen er reservert for kontoinnehaveren og kan ikke tildeles eller fjernes.

Liste medlemmer

Hent alle medlemmer og ventende invitasjoner på kontoen din.

GET /members

Eksempel

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

Respons

{
  "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 er active for medlemmer som har akseptert, eller pending for invitasjoner som ennå ikke er akseptert.

---

Invitere medlem

Inviter en person til kontoen via e-post. En invitasjons-e-post med en akseptlenke sendes til adressen.

POST /members

Parametere

Parameter	Type	Påkrevd	Beskrivelse
email	string	Ja	E-postadresse som skal inviteres (må være en gyldig e-post)
role	string	Ja	Rolle som skal tildeles — en av admin, editor, viewer

Eksempel

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

Respons

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

Feil

• 400 — role must be one of admin, editor, viewer
• 400 — ugyldig eller manglende e-postadresse
• 400 — seat limit reached — kontoen har ingen ledige plasser for abonnementet (Free: 2, Starter: 5, Pro: 20, inkludert eieren). Fjern et medlem eller oppgrader abonnementet.
• 400 — e-posten er allerede et medlem eller har en ventende invitasjon på denne kontoen

---

Akseptere invitasjon

Aksepter en ventende invitasjon. Den autentiserte brukerens e-post må samsvare med adressen invitasjonen ble sendt til.

POST /members/accept

Parametere

Parameter	Type	Påkrevd	Beskrivelse
inviteId	string	Ja	Invitasjons-ID-en fra akseptlenke-e-posten

Eksempel

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

Respons

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

Feil

• 400 — email does not match invitation — den innloggede e-posten skiller seg fra den inviterte e-posten
• 404 — invitasjon ikke funnet (allerede akseptert, kansellert, eller inviteId er feil)

---

Oppdatere medlemsrolle

Endre et eksisterende medlems rolle. Krever eier- eller administratorrettigheter.

POST /members/{memberId}/role

Parametere

Parameter	Type	Påkrevd	Beskrivelse
memberId	string	Ja	Medlems-ID-en (stiparameter)
role	string	Ja	Ny rolle — en av admin, editor, viewer

Eksempel

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

Respons

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

Feil

• 400 — role must be one of admin, editor, viewer
• 400 — the owner role cannot be changed
• 404 — medlem ikke funnet

---

Fjerne medlem

Fjern et medlem fra kontoen, eller kanseller en ventende invitasjon. Medlemmet mister umiddelbart tilgangen, og plassen frigjøres.

DELETE /members/{memberId}

Eksempel

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

Respons

En ren streng:

"member has been removed"

Feil

• 400 — the owner cannot be removed
• 404 — medlem ikke funnet