Verejné overenie

Tieto endpointy sú verejné a nevyžadujú autentifikáciu. Umožňujú komukoľvek overiť poverenia vo forme odznakov a získať údaje JSON Open Badge v2.0.

Všetky endpointy sú relatívne voči https://api.badges.ninja.

Získanie vydavateľa

Získajte JSON profilu vydavateľa Open Badge v2.0 pre daného vydavateľa.

GET /certify-badge/issuer/{guid}

Príklad

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

Odpoveď

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

---

Získanie odznaku

Získajte JSON BadgeClass Open Badge v2.0 pre daný odznak.

GET /certify-badge/badge/{guid}

Príklad

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

Odpoveď

{
  "@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-..."
}

---

Získanie poverenia

Získajte JSON Assertion Open Badge v2.0 pre dané poverenie.

GET /certify-badge/award/{guid}

Príklad

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

Odpoveď

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

Ak bolo poverenie odvolané, assertion obsahuje "revoked": true a, ak bol uvedený dôvod, reťazec "revocationReason":

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

Toto je pohľad na odvolanie v Open Badges 2.0. To isté odvolanie je vyjadrené aj vo Verifiable Credential Open Badges 3.0 tohto poverenia — pozrite si Odvolanie (Bitstring Status List).

Poznámky

• E-mail príjemcu je z dôvodu ochrany súkromia zahashovaný (SHA-256) podľa špecifikácie Open Badge.
• Odpovede sa ukladajú do vyrovnávacej pamäte na 5 minút (Cache-Control: public, max-age=300). Odvolané poverenia používajú kratšiu 30-sekundovú vyrovnávaciu pamäť (max-age=30), aby sa odvolanie šírilo rýchlo.

---

Získanie textu na zdieľanie poverenia

Získajte vlastný text na zdieľanie pre odznak poverenia.

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

Príklad

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

Odpoveď

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

Ak nie je nastavený žiadny vlastný text na zdieľanie, vráti sa predvolená správa.

---

Odoslanie e-mailu o poverení (verejné)

Odošlite e-mailové oznámenie o poverení z verejného endpointu. Používa ho verejná stránka na zdieľanie.

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

Parametre

Parameter	Typ	Povinný	Popis
recipients	string	Áno	Zoznam e-mailových adries oddelených čiarkou
message	string	Nie	Vlastná správa, ktorá sa zahrnie do e-mailu

Príklad

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

Odpoveď

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

Toto je jediný endpoint, ktorý obaľuje svoj výsledok do obálky { "statusCode", "info" }. Všetky ostatné endpointy vracajú svoje dáta priamo.

---

Overenie vydavateľa

Overte vydavateľa kliknutím na overovací odkaz odoslaný na e-mail vydavateľa. Zvyčajne sa otvára cez odkaz v overovacom e-maile, nevolá sa priamo.

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

Parametre

Parameter	Typ	Popis
guid	string	GUID vydavateľa
code	string	Overovací kód

Odpoveď

Vráti HTML stránku potvrdzujúcu, že overenie uspelo alebo zlyhalo. Tento endpoint je určený na otvorenie v prehliadači.