Javno preverjanje

Te končne točke so javne in ne zahtevajo preverjanja pristnosti. Vsakomur omogočajo, da preveri poverilnice značk in pridobi podatke JSON Open Badge v2.0.

Vse končne točke so relativne glede na https://api.badges.ninja.

Pridobitev izdajatelja

Pridobite JSON profila izdajatelja (Issuer Profile) Open Badge v2.0 za določenega 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"
  }
}

---

Pridobitev značke

Pridobite JSON BadgeClass Open Badge v2.0 za določeno 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://badges.ninja/images/{sha256}.png",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Pridobitev poverilnice

Pridobite JSON Assertion Open Badge v2.0 za določeno poverilnico.

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"
  },
  "revoked": false
}

Če je bila poverilnica preklicana, assertion vsebuje "revoked": true in, kadar je bil naveden razlog, niz "revocationReason":

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

To je pogled preklica po Open Badges 2.0. Isti preklic je izražen tudi v poverilnici Open Badges 3.0 Verifiable Credential — glejte Preklic (Bitstring Status List).

Opombe

• E-poštni naslov prejemnika je zaradi zasebnosti zgoščen (SHA-256), v skladu s specifikacijo Open Badge.
• Odgovori se predpomnijo 5 minut (Cache-Control: public, max-age=300). Preklicane poverilnice uporabljajo krajši 30-sekundni predpomnilnik (max-age=30), da se preklic hitro razširi.

---

Pridobitev besedila za deljenje poverilnice

Pridobite besedilo za deljenje po meri za značko poverilnice.

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 besedilo za deljenje po meri ni nastavljeno, se vrne privzeto sporočilo.

---

Pošiljanje e-pošte o poverilnici (javno)

Pošljite e-poštno obvestilo o poverilnici prek javne končne točke. Uporablja jo javna stran za deljenje.

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

Parametri

Parameter	Tip	Obvezno	Opis
recipients	string	Da	Z vejicami ločen seznam e-poštnih naslovov
message	string	Ne	Sporočilo po meri, ki bo vključeno 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"
}

To je edina končna točka, ki svoj rezultat ovije v ovojnico { "statusCode", "info" }. Vse druge končne točke vrnejo svoj podatkovni sklop neposredno.

---

Preverjanje izdajatelja

Izdajatelja preverite s klikom na povezavo za preverjanje, poslano na e-poštni naslov izdajatelja. Običajno se do nje dostopa prek povezave v e-pošti za preverjanje, ne kliče se je 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 bilo preverjanje uspešno ali neuspešno. Ta končna točka je namenjena odpiranju v brskalniku.