Kibocsátók API

Kezeld a jelvénykibocsátókat — azokat a szervezeteket vagy személyeket, akik jelvényeket bocsátanak ki.

Minden végponthoz hitelesítés szükséges az X-Api-Key fejlécen keresztül. Lásd: Hitelesítés.

Kibocsátó létrehozása

Új jelvénykibocsátó létrehozása.

POST /issuers

Paraméterek

Paraméter	Típus	Kötelező	Leírás
name	string	Igen	A szervezet neve (legalább 3 karakter)
url	string	Igen	A szervezet weboldala (érvényes HTTP/HTTPS URL-nek kell lennie)
email	string	Igen	A kibocsátó kapcsolattartási e-mail-címe
logo	string	Nem	Base64 kódolású kép (PNG vagy JPG)
linkedinOrganizationId	string	Nem	A LinkedIn-cégoldal numerikus azonosítója. Beállítva a kibocsátó minden nyilvános hitelesítőadat-oldalán megjelenik az Add to LinkedIn Profile gomb.

Példa

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

Válasz

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

Megjegyzések

• Beleszámít a csomagod kibocsátókorlátjába (Free: 2, Starter: 5, Pro: 10). Keretet nem von le.
• Ha a kibocsátó e-mail-címe megegyezik a fiókod e-mail-címével, a kibocsátó automatikusan ellenőrzötté válik.
• Ha az e-mail-cím eltér, ellenőrző e-mailt küldünk a kibocsátó címére.
• A kibocsátó beállítása után a Hitelesítő adatok API segítségével kezdhetsz hitelesítő adatokat kiadni az adott kibocsátó nevében.

---

Kibocsátók listázása

Az általad létrehozott összes kibocsátó lekérése.

GET /issuers

Példa

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

Válasz

{
  "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
    }
  ]
}

A timestamp ezredmásodpercben megadott Unix-időbélyeg. Ha több kibocsátó van, mint amennyi egy oldalra elfér, a lapozáshoz egy lastEvaluatedKey is visszatér.

---

Kibocsátó ellenőrzése

Kibocsátó ellenőrzése a címére küldött ellenőrző kóddal.

POST /issuers/{issuerId}/verify

Paraméterek

Paraméter	Típus	Kötelező	Leírás
issuerId	string	Igen	A kibocsátó azonosítója (útvonalparaméter)
code	string	Igen	Az e-mailben kapott ellenőrző kód

Példa

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

Válasz

Egyszerű string:

"issuer has been verified"

---

Kibocsátó törlése

Kibocsátó törlése. A kibocsátóhoz nem kapcsolódhat jelvény.

DELETE /issuers/{issuerId}

Példa

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

Válasz

Egyszerű string:

"issuer has been deleted"

Hibák

• 400 — a kibocsátóhoz még kapcsolódnak jelvények: issuer has {n} badge(s) linked — delete the badges first. A törlést kizárólag a kapcsolt jelvények akadályozzák — a hitelesítő adatok nem.
• 404 — a kibocsátó nem található

---

Kibocsátó módosítása

A kibocsátó mezőinek módosítása. Csak az ellenőrizetlen kibocsátók szerkeszthetők — az ellenőrzés után a végpont a hitelesítő adatok stabilitása érdekében 400 verified issuers cannot be edited hibát ad. A szerkesztés újragenerálja a kibocsátó ellenőrző kódját: ha az email megegyezik a fiókod e-mail-címével, a kibocsátó automatikusan újra ellenőrzötté válik, különben új ellenőrző e-mailt küldünk arra a címre.

PUT /issuers/{issuerId}

Paraméterek

Paraméter	Típus	Kötelező	Leírás
issuerId	string	Igen	A kibocsátó azonosítója (útvonalparaméter)
name	string	Nem	Új név
url	string	Nem	Új URL
email	string	Nem	Új e-mail-cím (új ellenőrző levelet küld, kivéve ha megegyezik a fiókod e-mail-címével)
logo	string	Nem	Új, base64 kódolású logó
linkedinOrganizationId	string	Nem	Új LinkedIn-szervezetazonosító (vagy üres string a törléséhez)

Válasz

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

Hibák

• 400 — verified issuers cannot be edited (a kibocsátó már ellenőrzött)
• 400 — not authorized (a kibocsátó másik fiókhoz tartozik)
• 404 — a kibocsátó nem található