Viešoji patikra

Š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 yra sąlyginiai pagal https://api.badges.ninja.

Gauti išdavėją

Gauti Open Badge v2.0 Issuer Profile JSON nurodytam išdavėjui.

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į

Gauti Open Badge v2.0 BadgeClass JSON nurodytam ženkleliui.

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://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Gauti apdovanojimą

Gauti Open Badge v2.0 Assertion JSON nurodytam apdovanojimui.

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

Pastabos

• Gavėjo el. paštas sumaišomas (SHA-256) privatumo sumetimais pagal Open Badge specifikaciją.
• Atsakymai kešuojami 1 valandą (Cache-Control: public, max-age=3600).

---

Gauti apdovanojimo dalijimosi tekstą

Gauti pasirinktinį apdovanojimo ženklelio 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 apdovanojimo el. laišką (viešai)

Siųsti apdovanojimo pranešimo el. laišką iš viešo galutinio taško. Tai naudoja viešas dalijimosi puslapis.

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

Parametrai

Parametras	Tipas	Privalomas	Aprašymas
recipients	string	Taip	Kableliais atskirtas el. paštų sąrašas
subject	string	Ne	El. laiško tema
message	string	Ne	Pasirinktinė žinutė, įtraukiama į 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"
}

---

Patvirtinti išdavėją

Patvirtinti išdavėją spustelėjus patvirtinimo nuorodą, išsiųstą į išdavėjo el. paštą. Paprastai pasiekiama per nuorodą patvirtinimo 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	Patvirtinimo kodas

Atsakymas

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