Verejné overovanie

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

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

Získať 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ískať odznak

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://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Získať udelenie

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

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

Poznámky

• E-mail príjemcu je hashovaný (SHA-256) pre súkromie, podľa špecifikácie Open Badge.
• Odpovede sú cachované po dobu 1 hodiny (Cache-Control: public, max-age=3600).

---

Získať text zdieľania udelenia

Získajte vlastný text zdieľania pre odznak udelenia.

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 zdieľania, vráti sa predvolená správa.

---

Odoslať e-mail udelenia (verejné)

Odošlite e-mail s upozornením na udelenie z verejného endpointu. Toto používa verejná stránka zdieľania.

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

Parametre

Parameter	Typ	Povinné	Popis
recipients	string	Áno	Zoznam e-mailových adries oddelených čiarkami
subject	string	Nie	Predmet e-mailu
message	string	Nie	Vlastná správa, ktorú zahrnúť 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"
}

---

Overiť vydavateľa

Overte vydavateľa kliknutím na overovací odkaz odoslaný na e-mail vydavateľa. Toto sa zvyčajne pristupuje cez odkaz v overovacom e-maile, nie volá 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 úspešné alebo neúspešné overenie. Tento endpoint je navrhnutý na otvorenie v prehliadači.