API za izdajatelje

Upravljajte izdajatelje značk — organizacije ali posameznike, ki izdajajo značke.

Vse končne točke zahtevajo overitev prek glave X-Api-Key. Glejte Overjanje.

Ustvari izdajatelja

Ustvarite novega izdajatelja značk.

POST /issuers

Parametri

Parameter	Tip	Obvezen	Opis
name	string	Da	Ime organizacije (najmanj 3 znaki)
url	string	Da	Spletna stran organizacije (mora biti veljaven URL HTTP/HTTPS)
email	string	Da	Kontaktni e-poštni naslov izdajatelja
logo	string	Ne	Slika, kodirana v Base64 (PNG ali JPG)
linkedinOrganizationId	string	Ne	Številčni ID strani podjetja na LinkedInu. Če je nastavljen, vsaka javna stran poverilnice tega izdajatelja prikaže gumb Add to LinkedIn Profile.

Primer

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com"
    }
  }'

Odgovor

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Opombe

• Šteje v omejitev števila izdajateljev v vašem paketu (Free: 2, Starter: 5, Pro: 10). Kvota se ne odšteva.
• Če e-poštni naslov izdajatelja ustreza e-poštnemu naslovu vašega računa, je izdajatelj samodejno preverjen.
• Če je e-poštni naslov drugačen, se na e-poštni naslov izdajatelja pošlje e-pošta za preverjanje.
• Po nastavitvi izdajatelja uporabite API za poverilnice, da začnete izdajati poverilnice pod tem izdajateljem.

---

Naštej izdajatelje

Pridobite vse izdajatelje, ki ste jih ustvarili.

GET /issuers

Primer

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

Odgovor

{
  "items": [
    {
      "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com",
      "verified": true,
      "timestamp": 1736937000000
    }
  ]
}

timestamp je čas Unix v milisekundah. Če izdajateljev ni mogoče prikazati na eni strani, se za razdelitev na strani vrne tudi lastEvaluatedKey.

---

Preveri izdajatelja

Preverite izdajatelja s kodo za preverjanje, poslano na njegov e-poštni naslov.

POST /issuers/{issuerId}/verify

Parametri

Parameter	Tip	Obvezen	Opis
issuerId	string	Da	ID izdajatelja (parameter poti)
code	string	Da	Koda za preverjanje iz e-pošte

Primer

curl -X POST https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/verify \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "ABC123"
    }
  }'

Odgovor

Navaden niz:

"issuer has been verified"

---

Izbriši izdajatelja

Izbrišite izdajatelja. Z izdajateljem ne sme biti povezana nobena značka.

DELETE /issuers/{issuerId}

Primer

curl -X DELETE https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Api-Key: bws_your_api_key_here"

Odgovor

Navaden niz:

"issuer has been deleted"

Napake

• 400 — z izdajateljem so še vedno povezane značke: issuer has {n} badge(s) linked — delete the badges first. Brisanje preprečujejo samo povezane značke — poverilnice brisanja ne blokirajo.
• 404 — izdajatelj ni najden

---

Posodobi izdajatelja

Posodobite polja izdajatelja. Urejati je mogoče samo nepreverjene izdajatelje — ko je izdajatelj preverjen, ta končna točka zaradi stabilnosti poverilnic vrne 400 verified issuers cannot be edited. Urejanje izdajatelja znova ustvari njegovo kodo za preverjanje: če se email ujema z e-poštnim naslovom vašega računa, je izdajatelj samodejno znova preverjen, sicer se na ta naslov pošlje nova e-pošta za preverjanje.

PUT /issuers/{issuerId}

Parametri

Parameter	Tip	Obvezen	Opis
issuerId	string	Da	ID izdajatelja (parameter poti)
name	string	Ne	Novo ime
url	string	Ne	Nov URL
email	string	Ne	Nov e-poštni naslov (pošlje novo e-pošto za preverjanje, razen če se ujema z e-poštnim naslovom vašega računa)
logo	string	Ne	Nov logotip, kodiran v Base64
linkedinOrganizationId	string	Ne	Nov ID organizacije na LinkedInu (ali prazen niz za izbris)

Odgovor

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "updated": true
}

Napake

• 400 — verified issuers cannot be edited (izdajatelj je že preverjen)
• 400 — not authorized (izdajatelj pripada drugemu računu)
• 404 — izdajatelj ni najden