Javno preverjanje

Ti endpointi so javni in ne zahtevajo avtentikacije. Omogočajo komurkoli preveriti spričevala značk in pridobiti podatke JSON Open Badge v2.0.

Vsi endpointi so relativni glede na https://api.badges.ninja.

Pridobi izdajatelja

Pridobite JSON profila izdajatelja Open Badge v2.0 za danega izdajatelja.

GET /certify-badge/issuer/{guid}

Primer

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

Odgovor

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

---

Pridobi značko

Pridobite JSON BadgeClass Open Badge v2.0 za dano značko.

GET /certify-badge/badge/{guid}

Primer

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

Odgovor

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

---

Pridobi podelitev

Pridobite JSON Assertion Open Badge v2.0 za dano podelitev.

GET /certify-badge/award/{guid}

Primer

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

Odgovor

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

Opombe

• E-pošta prejemnika je zgoščena (SHA-256) za zasebnost, po specifikaciji Open Badge.
• Odgovori so predpomnjeni za 1 uro (Cache-Control: public, max-age=3600).

---

Pridobi besedilo deljenja podelitve

Pridobite besedilo deljenja po meri za značko podelitve.

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

Primer

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

Odgovor

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

Če ni nastavljeno nobeno besedilo deljenja po meri, se vrne privzeto sporočilo.

---

Pošlji e-pošto podelitve (javno)

Pošljite e-poštno obvestilo o podelitvi z javnega endpointa. Tega uporablja javna stran za deljenje.

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

Parametri

Parameter	Tip	Obvezno	Opis
recipients	string	Da	Seznam e-poštnih naslovov, ločenih z vejicami
subject	string	Ne	Zadeva e-pošte
message	string	Ne	Sporočilo po meri za vključitev v e-pošto

Primer

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

Odgovor

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

---

Preveri izdajatelja

Preverite izdajatelja s klikom na povezavo za preverjanje, poslano na e-poštni naslov izdajatelja. To se običajno odpre prek povezave v e-pošti za preverjanje, ne kliče neposredno.

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

Parametri

Parameter	Tip	Opis
guid	string	GUID izdajatelja
code	string	Koda za preverjanje

Odgovor

Vrne stran HTML, ki potrjuje, da je preverjanje uspelo ali ni. Ta endpoint je zasnovan za odpiranje v brskalniku.