API vydavatelů

Spravujte vydavatele odznaků — organizace nebo jednotlivce, kteří odznaky vydávají.

Všechny endpointy vyžadují autentizaci přes hlavičku X-Api-Key. Viz Autentizace.

Vytvořit vydavatele

Vytvořte nového vydavatele odznaků.

POST /issuers

Parametry

Parametr	Typ	Povinný	Popis
name	string	Ano	Název organizace (minimálně 3 znaky)
url	string	Ano	Web organizace (musí být platná URL HTTP/HTTPS)
email	string	Ano	Kontaktní e-mail vydavatele
logo	string	Ne	Obrázek zakódovaný v Base64 (PNG nebo JPG)
linkedinOrganizationId	string	Ne	Číselné ID firemní stránky na LinkedIn. Je-li nastaveno, každá veřejná stránka pověření od tohoto vydavatele zobrazí tlačítko Add to LinkedIn Profile.

Pří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"
    }
  }'

Odpověď

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

Poznámky

• Započítává se do limitu vydavatelů vašeho plánu (Free: 2, Starter: 5, Pro: 10). Neodečítá se žádná kvóta.
• Pokud se e-mail vydavatele shoduje s e-mailem vašeho účtu, vydavatel je ověřen automaticky.
• Pokud je e-mail jiný, na e-mail vydavatele se odešle ověřovací e-mail.
• Po nastavení vydavatele použijte API pověření a začněte pod tímto vydavatelem vydávat pověření.

---

Seznam vydavatelů

Získejte všechny vydavatele, které jste vytvořili.

GET /issuers

Příklad

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

Odpověď

{
  "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 Unix epoch v milisekundách. Pokud existuje více vydavatelů, než se vejde na jednu stránku, vrátí se pro stránkování také lastEvaluatedKey.

---

Ověřit vydavatele

Ověřte vydavatele pomocí ověřovacího kódu zaslaného na jeho e-mail.

POST /issuers/{issuerId}/verify

Parametry

Parametr	Typ	Povinný	Popis
issuerId	string	Ano	ID vydavatele (parametr cesty)
code	string	Ano	Ověřovací kód z e-mailu

Pří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"
    }
  }'

Odpověď

Holý řetězec:

"issuer has been verified"

---

Smazat vydavatele

Smažte vydavatele. K vydavateli nesmí být připojeny žádné odznaky.

DELETE /issuers/{issuerId}

Příklad

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

Odpověď

Holý řetězec:

"issuer has been deleted"

Chyby

• 400 — k vydavateli jsou stále připojeny odznaky: issuer has {n} badge(s) linked — delete the badges first. Smazání blokují pouze připojené odznaky — pověření ho neblokují.
• 404 — vydavatel nenalezen

---

Aktualizovat vydavatele

Aktualizujte pole vydavatele. Upravovat lze pouze neověřené vydavatele — jakmile je vydavatel ověřen, tento endpoint vrací 400 verified issuers cannot be edited, aby zůstala zachována stabilita pověření. Úprava vydavatele vygeneruje nový ověřovací kód: pokud se email shoduje s e-mailem vašeho účtu, vydavatel je automaticky znovu ověřen, jinak se na uvedenou adresu odešle nový ověřovací e-mail.

PUT /issuers/{issuerId}

Parametry

Parametr	Typ	Povinný	Popis
issuerId	string	Ano	ID vydavatele (parametr cesty)
name	string	Ne	Nový název
url	string	Ne	Nová URL
email	string	Ne	Nový e-mail (odešle nový ověřovací e-mail, pokud se neshoduje s e-mailem vašeho účtu)
logo	string	Ne	Nové logo zakódované v Base64
linkedinOrganizationId	string	Ne	Nové ID organizace na LinkedIn (nebo prázdný řetězec pro vymazání)

Odpověď

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

Chyby

• 400 — verified issuers cannot be edited (vydavatel je již ověřen)
• 400 — not authorized (vydavatel patří k jinému účtu)
• 404 — vydavatel nenalezen