Veřejné ověření

Tyto endpointy jsou veřejné a nevyžadují autentizaci. Umožňují komukoli ověřit pověření k odznakům a získat data JSON ve formátu Open Badge v2.0.

Všechny endpointy jsou relativní vůči https://api.badges.ninja.

Získat vydavatele

Získejte JSON profilu vydavatele (Issuer Profile) ve formátu Open Badge v2.0 pro daného vydavatele.

GET /certify-badge/issuer/{guid}

Příklad

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

Odpověď

{
  "@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ískat odznak

Získejte JSON BadgeClass ve formátu Open Badge v2.0 pro daný odznak.

GET /certify-badge/badge/{guid}

Příklad

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

Odpověď

{
  "@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ískat pověření

Získejte JSON Assertion ve formátu Open Badge v2.0 pro dané pověření.

GET /certify-badge/award/{guid}

Příklad

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

Odpověď

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

Pokud bylo pověření odvoláno, assertion obsahuje "revoked": true a, byl-li uveden důvod, řetězec "revocationReason":

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

Toto je pohled na odvolání podle Open Badges 2.0. Totéž odvolání je vyjádřeno také ve Verifiable Credential pověření ve formátu Open Badges 3.0 — viz Odvolání (Bitstring Status List).

Poznámky

• E-mail příjemce je z důvodu ochrany soukromí zahashován (SHA-256) v souladu se specifikací Open Badge.
• Odpovědi se ukládají do mezipaměti na 5 minut (Cache-Control: public, max-age=300). Odvolaná pověření používají kratší mezipaměť 30 sekund (max-age=30), aby se odvolání rychle propagovalo.

---

Získat text ke sdílení pověření

Získejte vlastní text ke sdílení pro odznak daného pověření.

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

Příklad

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

Odpověď

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

Pokud není nastaven žádný vlastní text ke sdílení, vrátí se výchozí zpráva.

---

Odeslat e-mail s pověřením (veřejný)

Odešlete e-mailové oznámení o pověření z veřejného endpointu. Používá ho veřejná stránka pro sdílení.

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

Parametry

Parametr	Typ	Povinný	Popis
recipients	string	Ano	Seznam e-mailových adres oddělených čárkou
message	string	Ne	Vlastní zpráva, která se zahrne do e-mailu

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

Odpověď

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

Toto je jediný endpoint, který obaluje svůj výsledek do obálky { "statusCode", "info" }. Všechny ostatní endpointy vracejí svá data přímo.

---

Ověřit vydavatele

Ověřte vydavatele kliknutím na ověřovací odkaz zaslaný na e-mail vydavatele. Obvykle se otevírá přes odkaz v ověřovacím e-mailu, nevolá se přímo.

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

Parametry

Parametr	Typ	Popis
guid	string	GUID vydavatele
code	string	Ověřovací kód

Odpověď

Vrátí HTML stránku potvrzující, zda ověření uspělo, nebo selhalo. Tento endpoint je navržen tak, aby se otevíral v prohlížeči.