Members API

Administrér teampladser og roller — de personer, der deler din kontos udstedere, mærker og beviser.

Alle endpoints kræver godkendelse. Se Godkendelse. Hver anmodning er afgrænset til den godkendte ejers konto.

Roller, der kan tildeles via API'et, er admin, editor og viewer. Rollen owner er reserveret til kontoindehaveren og kan ikke tildeles eller fjernes.

Vis medlemmer

Hent alle medlemmer og afventende invitationer på din konto.

GET /members

Eksempel

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

Svar

{
  "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, der har accepteret, eller pending for invitationer, der endnu ikke er blevet accepteret.

---

Invitér medlem

Invitér en person til kontoen via e-mail. En invitations-e-mail med et acceptlink sendes til adressen.

POST /members

Parametre

Parameter	Type	Påkrævet	Beskrivelse
email	string	Ja	E-mailadresse, der skal inviteres (skal være en gyldig e-mail)
role	string	Ja	Rolle, der skal tildeles — én af 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"
    }
  }'

Svar

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

Fejl

• 400 — role must be one of admin, editor, viewer
• 400 — ugyldig eller manglende e-mailadresse
• 400 — seat limit reached — kontoen har ingen ledige pladser til planen (Free: 2, Starter: 5, Pro: 20, inklusive ejeren). Fjern et medlem eller opgradér planen.
• 400 — e-mailen er allerede et medlem eller har en afventende invitation på denne konto

---

Accept invitation

Accepter en afventende invitation. Den godkendte brugers e-mail skal matche den adresse, invitationen blev sendt til.

POST /members/accept

Parametre

Parameter	Type	Påkrævet	Beskrivelse
inviteId	string	Ja	Invitations-ID'et fra acceptlink-e-mailen

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

Svar

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

Fejl

• 400 — email does not match invitation — den indloggede e-mail afviger fra den inviterede e-mail
• 404 — invitation ikke fundet (allerede accepteret, annulleret, eller inviteId er forkert)

---

Opdatér medlemsrolle

Ændr et eksisterende medlems rolle. Kræver ejer- eller admin-rettigheder.

POST /members/{memberId}/role

Parametre

Parameter	Type	Påkrævet	Beskrivelse
memberId	string	Ja	Medlems-ID'et (stiparameter)
role	string	Ja	Ny rolle — én af 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"
    }
  }'

Svar

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

Fejl

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

---

Fjern medlem

Fjern et medlem fra kontoen, eller annullér en afventende invitation. Medlemmet mister med det samme adgangen, og dets plads frigives.

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"

Svar

En ren streng:

"member has been removed"

Fejl

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