Nyilvános ellenőrzés

Ezek a végpontok nyilvánosak, és nem igényelnek hitelesítést. Bárki számára lehetővé teszik a jelvények hitelesítő adatainak ellenőrzését és az Open Badge v2.0 JSON-adatok lekérdezését.

Minden végpont a https://api.badges.ninja címhez képest relatív.

Kibocsátó lekérése

Kérd le egy adott kibocsátó Open Badge v2.0 Issuer Profile JSON-ját.

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

Kérd le egy adott jelvény Open Badge v2.0 BadgeClass JSON-ját.

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://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Hitelesítő adat lekérése

Kérd le egy adott hitelesítő adat Open Badge v2.0 Assertion JSON-ját.

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"
  },
  "revoked": false
}

Ha a hitelesítő adatot visszavonták, az assertion tartalmazza a "revoked": true mezőt, és – ha megadtak indoklást – egy "revocationReason" karakterláncot:

{
  "revoked": true,
  "revocationReason": "Issued in error"
}

Ez a visszavonás Open Badges 2.0 szerinti nézete. Ugyanez a visszavonás a hitelesítő adat Open Badges 3.0 Verifiable Credentialjében is megjelenik — lásd: Visszavonás (Bitstring Status List).

Megjegyzések

• A címzett e-mail-címét az adatvédelem érdekében az Open Badge specifikációnak megfelelően hash-eljük (SHA-256).
• A válaszok 5 percig gyorsítótárazottak (Cache-Control: public, max-age=300). A visszavont hitelesítő adatok rövidebb, 30 másodperces gyorsítótárat használnak (max-age=30), hogy a visszavonás gyorsan érvényesüljön.

---

Hitelesítő adat megosztási szövegének lekérése

Kérd le egy hitelesítő adat jelvényének egyéni megosztási szövegét.

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, egy alapértelmezett üzenetet kapsz vissza.

---

Hitelesítőadat-értesítő e-mail küldése (nyilvános)

Küldj hitelesítőadat-értesítő e-mailt a nyilvános végpontról. Ezt a nyilvános megosztási 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 listája
message	string	Nem	Az e-mailben szerepeltetendő 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"
}

Ez az egyetlen végpont, amely az eredményét egy { "statusCode", "info" } borítékba csomagolja. Az összes többi végpont közvetlenül adja vissza a tartalmat.

---

Kibocsátó ellenőrzése

Ellenőrizd a kibocsátót a kibocsátó e-mail-címére küldött ellenőrző hivatkozásra kattintva. Ezt általában az ellenőrző e-mailben lévő hivatkozáson keresztül nyitják meg, nem közvetlenül hívják.

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

Egy HTML-oldalt ad vissza, amely megerősíti, hogy az ellenőrzés sikerült-e vagy sem. Ezt a végpontot böngészőben való megnyitásra tervezték.