Viešas patikrinimas

Šie galutiniai taškai yra vieši ir nereikalauja autentikavimo. Jie leidžia bet kam patikrinti ženklelių pažymėjimus ir gauti Open Badge v2.0 JSON duomenis.

Visi galutiniai taškai nurodomi https://api.badges.ninja atžvilgiu.

Gauti išdavėją

Gaukite nurodyto išdavėjo Open Badge v2.0 Issuer Profile JSON.

GET /certify-badge/issuer/{guid}

Pavyzdys

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

Atsakymas

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

---

Gauti ženklelį

Gaukite nurodyto ženklelio Open Badge v2.0 BadgeClass JSON.

GET /certify-badge/badge/{guid}

Pavyzdys

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

Atsakymas

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

---

Gauti pažymėjimą

Gaukite nurodyto pažymėjimo Open Badge v2.0 Assertion JSON.

GET /certify-badge/award/{guid}

Pavyzdys

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

Atsakymas

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

Jei pažymėjimas buvo atšauktas, assertion turi "revoked": true, o jei nurodyta priežastis – ir "revocationReason" eilutę:

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

Tai yra atšaukimo vaizdas pagal Open Badges 2.0. Tas pats atšaukimas išreiškiamas ir pažymėjimo Open Badges 3.0 Verifiable Credential – žr. Atšaukimas (Bitstring Status List).

Pastabos

• Gavėjo el. paštas maskuojamas (SHA-256) dėl privatumo, vadovaujantis Open Badge specifikacija.
• Atsakymai talpinami podėlyje 5 minutėms (Cache-Control: public, max-age=300). Atšaukti pažymėjimai naudoja trumpesnį 30 sekundžių podėlį (max-age=30), kad atšaukimas išplistų greitai.

---

Gauti pažymėjimo dalijimosi tekstą

Gaukite pažymėjimo ženklelio pasirinktinį dalijimosi tekstą.

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

Pavyzdys

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

Atsakymas

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

Jei pasirinktinis dalijimosi tekstas nenustatytas, grąžinamas numatytasis pranešimas.

---

Siųsti pažymėjimo el. laišką (viešas)

Išsiųskite pažymėjimo pranešimo el. laišką iš viešo galutinio taško. Jis naudojamas viešame dalijimosi puslapyje.

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

Parametrai

Parametras	Tipas	Privalomas	Aprašymas
recipients	string	Taip	El. pašto adresų sąrašas, atskirtas kableliais
message	string	Ne	Pasirinktinis pranešimas, įtraukiamas į el. laišką

Pavyzdys

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

Atsakymas

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

Tai vienintelis galutinis taškas, kuris rezultatą apgaubia { "statusCode", "info" } voku. Visi kiti galutiniai taškai grąžina duomenis tiesiogiai.

---

Patikrinti išdavėją

Patikrinkite išdavėją paspausdami patikrinimo nuorodą, išsiųstą išdavėjo el. paštu. Paprastai ji atidaroma per nuorodą patikrinimo el. laiške, o ne kviečiama tiesiogiai.

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

Parametrai

Parametras	Tipas	Aprašymas
guid	string	Išdavėjo GUID
code	string	Patikrinimo kodas

Atsakymas

Grąžina HTML puslapį, patvirtinantį, kad patikrinimas pavyko arba nepavyko. Šis galutinis taškas skirtas atidaryti naršyklėje.