Kibocsátók API

Kezeld a jelvénykibocsátókat — a jelvényeket kiadó szervezeteket vagy személyeket.

Minden végpont az X-Api-Key fejléccel történő hitelesítést igényli. 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)
email	string	Igen	A kibocsátó kapcsolati e-mail-címe
logo	string	Nem	Base64-kódolású kép (PNG vagy JPG)
linkedinOrganizationId	string	Nem	A LinkedIn céges oldalának numerikus azonosítója. Ha be van állítva, a kibocsátó minden nyilvános kiadási oldalán megjelenik a Hozzáadás a LinkedIn-profilhoz 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

{
  "statusCode": 200,
  "info": {
    "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: 1, Starter: 5, Pro: korlátlan). Keret nem kerül levonásra.
• Ha a kibocsátó e-mail-címe megegyezik a fiókod e-mail-címével, a kibocsátó automatikusan ellenőrzésre kerül.
• Ha eltér, ellenőrző levelet küldünk a kibocsátó e-mail-címére.

---

Kibocsátók listázása

Kérj le minden létrehozott kibocsátót.

GET /issuers

Példa

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

Válasz

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

---

Kibocsátó ellenőrzése

Kibocsátó ellenőrzése az e-mailre elkü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 (elérési útban)
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

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

---

Kibocsátó törlése

Kibocsátó törlése. A kibocsátónak nem lehet jelvénye.

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

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

Hibák

• 400 — a kibocsátóhoz jelvények vagy kiadások tartoznak, nem törölhető (azokat töröld előbb)
• 404 — kibocsátó nem található

---

Kibocsátó frissítése

Nem ellenőrzött kibocsátó mezőinek frissítése. Miután a kibocsátó ellenőrzésre került, már csak a logo és a linkedinOrganizationId szerkeszthető, hogy a bizonyítványok stabilak maradjanak.

PUT /issuers/{issuerId}

Paraméterek

Paraméter	Típus	Kötelező	Leírás
issuerId	string	Igen	A kibocsátó azonosítója (elérési útban)
name	string	Nem	Új név (csak nem ellenőrzött állapotban)
url	string	Nem	Új URL (csak nem ellenőrzött állapotban)
email	string	Nem	Új e-mail-cím (csak nem ellenőrzött állapotban — új ellenőrző levelet küld)
logo	string	Nem	Új base64-kódolású logó
linkedinOrganizationId	string	Nem	Új LinkedIn-szervezet-azonosító (vagy üres sztring a törléshez)

---

Ellenőrző kód forgatása

Érvényteleníti az előző ellenőrző hivatkozást, és új kódot küld e-mailben. Csak addig használható, amíg a kibocsátó még nem ellenőrzött.

POST /issuers/{issuerId}/rotate-code

Válasz

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