Veřejné ověření

Tyto endpointy jsou veřejné a nevyžadují autentizaci. Umožňují komukoli ověřit osvědčení odznaků a získat data JSON Open Badge v2.0.

Všechny endpointy jsou relativní k https://api.badges.ninja.

Získat vydavatele

Načtěte JSON profilu vydavatele 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

Načtěte JSON BadgeClass 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://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Získat udělení

Načtěte JSON Assertion Open Badge v2.0 pro dané udělení.

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

Poznámky

• E-mail příjemce je hashován (SHA-256) kvůli soukromí, podle specifikace Open Badge.
• Odpovědi jsou kešovány po dobu 1 hodiny (Cache-Control: public, max-age=3600).

---

Získat text sdílení udělení

Načtěte vlastní text sdílení pro odznak udělení.

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 vlastní text sdílení, vrátí se výchozí zpráva.

---

Odeslat e-mail s udělením (veřejně)

Odešlete e-mail s upozorněním na udělení z veřejného endpointu. Toto používá veřejná stránka 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
subject	string	Ne	Předmět e-mailu
message	string	Ne	Vlastní zpráva k zahrnutí v 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"
}

---

Ověřit vydavatele

Ověřte vydavatele kliknutím na ověřovací odkaz odeslaný na e-mail vydavatele. Obvykle se k tomu přistupuje přes odkaz v ověřovacím e-mailu, ne přímým voláním.

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

Parametry

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

Odpověď

Vrací HTML stránku potvrzující úspěch nebo selhání ověření. Tento endpoint je navržen pro otevření v prohlížeči.