Issuers API

Spravujte vydavateľov odznakov — organizácie alebo jednotlivcov, ktorí udeľujú odznaky.

Všetky endpointy vyžadujú autentifikáciu cez hlavičku X-Api-Key. Pozri Autentifikácia.

Vytvoriť 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	Webstránka organizácie (musí byť platná HTTP/HTTPS URL)
email	string	Áno	Kontaktný e-mail vydavateľa
logo	string	Nie	Obrázok kódovaný v Base64 (PNG alebo JPG)
linkedinOrganizationId	string	Nie	Číselné ID firemnej stránky LinkedIn. Keď je nastavené, každá verejná stránka udelenia od 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ď

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

Poznámky

• Počíta sa proti limitu vydavateľov vášho plánu (Free: 1, Starter: 5, Pro: neobmedzene). Bez odpočtu kvóty.
• Ak sa e-mail vydavateľa zhoduje s e-mailom vášho účtu, vydavateľ sa overí automaticky.
• Ak je e-mail odlišný, na e-mail vydavateľa sa odošle overovací e-mail.

---

Zobraziť 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ď

{
  "statusCode": 200,
  "info": {
    "issuers": [
      {
        "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": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Overiť 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ď

{
  "statusCode": 200,
  "info": {
    "verified": true
  }
}

---

Odstrániť vydavateľa

Odstráňte vydavateľa. Vydavateľ nesmie mať ž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ď

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Chyby

• 400 — vydavateľ má odznaky alebo udelenia a nemožno ho odstrániť (najprv odstráňte tie)
• 404 — vydavateľ sa nenašiel

---

Aktualizovať vydavateľa

Aktualizujte polia neovereného vydavateľa. Po overení vydavateľa zostávajú upraviteľné iba logo a linkedinOrganizationId, aby sa zachovala stabilita osvedčenia.

PUT /issuers/{issuerId}

Parametre

Parameter	Typ	Povinné	Popis
issuerId	string	Áno	ID vydavateľa (parameter cesty)
name	string	Nie	Nový názov (iba keď je neoverený)
url	string	Nie	Nová URL (iba keď je neoverený)
email	string	Nie	Nový e-mail (iba keď je neoverený — odošle nový overovací e-mail)
logo	string	Nie	Nové logo kódované v Base64
linkedinOrganizationId	string	Nie	Nové LinkedIn organization ID (alebo prázdny reťazec na vymazanie)

---

Rotovať overovací kód

Zneplatnite predchádzajúci overovací odkaz a pošlite e-mailom nový. Platné iba kým je vydavateľ stále neoverený.

POST /issuers/{issuerId}/rotate-code

Odpoveď

{
  "statusCode": 200,
  "info": {
    "sent": true
  }
}