Nyilvános ellenőrzés

Ezek a végpontok nyilvánosak, és nem igényelnek hitelesítést. Lehetővé teszik, hogy bárki ellenőrizze a jelvénybizonyítványokat, és lekérje az Open Badge v2.0 JSON-adatokat.

Minden végpont a https://api.badges.ninja cím alá esik.

Kibocsátó lekérése

Egy adott kibocsátó Open Badge v2.0 Issuer Profile JSON-jának lekérése.

GET /certify-badge/issuer/{guid}

Példa

curl https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Válasz

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Issuer",
  "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "name": "Acme Academy",
  "url": "https://acme.example.com",
  "email": "badges@acme.example.com",
  "verification": {
    "type": "hosted",
    "allowedOrigins": "api.badges.ninja"
  }
}

---

Jelvény lekérése

Egy adott jelvény Open Badge v2.0 BadgeClass JSON-jának lekérése.

GET /certify-badge/badge/{guid}

Példa

curl https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901

Válasz

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "BadgeClass",
  "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "name": "JavaScript Fundamentals",
  "description": "Demonstrates proficiency in core JavaScript concepts",
  "criteria": {
    "narrative": "Completed the JavaScript Fundamentals course with a score of 80% or higher"
  },
  "image": "https://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Kiadás lekérése

Egy adott kiadás Open Badge v2.0 Assertion JSON-jának lekérése.

GET /certify-badge/award/{guid}

Példa

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012

Válasz

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Assertion",
  "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
  "recipient": {
    "type": "email",
    "hashed": true,
    "identity": "sha256$..."
  },
  "badge": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "issuedOn": "2025-01-15T00:00:00.000Z",
  "verification": {
    "type": "hosted"
  }
}

Megjegyzések

• A címzett e-mail-címét adatvédelmi okból hasheljük (SHA-256), az Open Badge specifikációnak megfelelően.
• A válaszokat 1 órán át gyorsítótárazzuk (Cache-Control: public, max-age=3600).

---

Kiadás megosztási szövegének lekérése

Egy kiadáshoz tartozó jelvény egyéni megosztási szövegének lekérése.

GET /certify-badge/award/{guid}/share-text

Példa

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/share-text

Válasz

{
  "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
}

Ha nincs beállítva egyéni megosztási szöveg, a rendszer alapértelmezett üzenetet ad vissza.

---

Kiadási e-mail küldése (nyilvános)

Kiadási értesítő e-mail küldése a nyilvános végpontról. A nyilvános megosztó oldal használja.

POST /certify-badge/award/{guid}/send-email

Paraméterek

Paraméter	Típus	Kötelező	Leírás
recipients	string	Igen	Vesszővel elválasztott e-mail-címek
subject	string	Nem	Az e-mail tárgya
message	string	Nem	Az e-mailbe beillesztendő egyéni üzenet

Példa

curl -X POST https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/send-email \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "recipients": "colleague@example.com",
      "message": "Check out this badge!"
    }
  }'

Válasz

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

---

Kibocsátó ellenőrzése

Kibocsátó ellenőrzése a kibocsátói e-mailben kapott ellenőrző hivatkozásra kattintva. Ezt a végpontot általában a hivatkozáson keresztül érik el, nem közvetlen hívással.

GET /certify-badge/verify-issuer/{guid}/{code}

Paraméterek

Paraméter	Típus	Leírás
guid	string	A kibocsátó GUID-ja
code	string	Az ellenőrző kód

Válasz

HTML-oldalt ad vissza, amely megerősíti, hogy az ellenőrzés sikeres volt vagy hibát jelez. A végpontot böngészőben való megnyitásra szántuk.