API vydavateľov

Správa vydavateľov odznakov — organizácií alebo jednotlivcov, ktorí odznaky vydávajú.

Všetky koncové body vyžadujú autentifikáciu cez hlavičku X-Api-Key. Pozrite si Authentication.

Vytvorenie vydavateľa

Vytvorte nového vydavateľa odznakov.

POST /issuers

Parametre

Parameter	Typ	Povinný	Popis
name	string	Áno	Názov organizácie (minimálne 3 znaky)
url	string	Áno	Webová stránka organizácie (musí byť platná URL HTTP/HTTPS)
email	string	Áno	Kontaktný e-mail vydavateľa
logo	string	Nie	Obrázok zakódovaný v Base64 (PNG alebo JPG)
linkedinOrganizationId	string	Nie	Číselné ID firemnej stránky na LinkedIn. Ak je nastavené, každá verejná stránka poverenia tohto vydavateľa zobrazuje tlačidlo Add to LinkedIn Profile.

Príklad

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

Odpoveď

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

Poznámky

• Počíta sa do limitu vydavateľov vášho plánu (Free: 2, Starter: 5, Pro: 10). Neodpočítava sa žiadna kvóta.
• Ak sa e-mail vydavateľa zhoduje s e-mailom vášho účtu, vydavateľ sa overí automaticky.
• Ak je e-mail iný, na e-mail vydavateľa sa odošle overovací e-mail.
• Po nastavení vydavateľa použite Credentials API a začnite vydávať poverenia pod týmto vydavateľom.

---

Zoznam vydavateľov

Získajte všetkých vydavateľov, ktorých ste vytvorili.

GET /issuers

Príklad

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

Odpoveď

{
  "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 epoch v milisekundách. Ak existuje viac vydavateľov, než sa zmestí na jednu stránku, vráti sa navyše lastEvaluatedKey na stránkovanie.

---

Overenie vydavateľa

Overte vydavateľa pomocou overovacieho kódu odoslaného na jeho e-mail.

POST /issuers/{issuerId}/verify

Parametre

Parameter	Typ	Povinný	Popis
issuerId	string	Áno	ID vydavateľa (parameter cesty)
code	string	Áno	Overovací kód z e-mailu

Príklad

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

Odpoveď

Holý reťazec:

"issuer has been verified"

---

Odstránenie vydavateľa

Odstráňte vydavateľa. Vydavateľ nesmie mať priradené žiadne odznaky.

DELETE /issuers/{issuerId}

Príklad

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

Odpoveď

Holý reťazec:

"issuer has been deleted"

Chyby

• 400 — vydavateľ má stále priradené odznaky: issuer has {n} badge(s) linked — delete the badges first. Odstránenie závisí iba od priradených odznakov — poverenia ho neblokujú.
• 404 — vydavateľ sa nenašiel

---

Aktualizácia vydavateľa

Aktualizujte polia vydavateľa. Upravovať možno iba neoverených vydavateľov — keď je vydavateľ overený, tento koncový bod vráti 400 verified issuers cannot be edited, aby sa zachovala stabilita poverení. Úprava vydavateľa znovu vygeneruje jeho overovací kód: ak sa email zhoduje s e-mailom vášho účtu, vydavateľ sa automaticky znovu overí, inak sa na túto adresu odošle nový overovací e-mail.

PUT /issuers/{issuerId}

Parametre

Parameter	Typ	Povinný	Popis
issuerId	string	Áno	ID vydavateľa (parameter cesty)
name	string	Nie	Nový názov
url	string	Nie	Nová URL
email	string	Nie	Nový e-mail (odošle nový overovací e-mail, ak sa nezhoduje s e-mailom vášho účtu)
logo	string	Nie	Nové logo zakódované v Base64
linkedinOrganizationId	string	Nie	Nové ID organizácie na LinkedIn (alebo prázdny reťazec na vymazanie)

Odpoveď

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

Chyby

• 400 — verified issuers cannot be edited (vydavateľ je už overený)
• 400 — not authorized (vydavateľ patrí inému účtu)
• 404 — vydavateľ sa nenašiel