Avalik kinnitamine

Need otspunktid on avalikud ega nõua autentimist. Need võimaldavad igaühel kinnitada märgitõendeid ja pärida Open Badge v2.0 JSON-andmeid.

Kõik otspunktid on suhtelised aadressi https://api.badges.ninja suhtes.

Hangi väljaandja

Pärige antud väljaandja Open Badge v2.0 väljaandja profiili (Issuer Profile) JSON.

GET /certify-badge/issuer/{guid}

Näide

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

Vastus

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

---

Hangi märk

Pärige antud märgi Open Badge v2.0 BadgeClass JSON.

GET /certify-badge/badge/{guid}

Näide

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

Vastus

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

---

Hangi tõend

Pärige antud tõendi Open Badge v2.0 Assertion JSON.

GET /certify-badge/award/{guid}

Näide

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

Vastus

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

Kui tõend on tühistatud, sisaldab assertion välja "revoked": true ja, kui põhjus on antud, stringi "revocationReason":

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

See on tühistamise Open Badges 2.0 vaade. Sama tühistamine on väljendatud ka tõendi Open Badges 3.0 Verifiable Credentialis — vt Tühistamine (Bitstring Status List).

Märkused

• Saaja e-posti aadress on privaatsuse huvides räsitud (SHA-256) vastavalt Open Badge spetsifikatsioonile.
• Vastuseid vahemälustatakse 5 minutit (Cache-Control: public, max-age=300). Tühistatud tõendite puhul kasutatakse lühemat 30-sekundilist vahemälu (max-age=30), et tühistamine leviks kiiresti.

---

Hangi tõendi jagamistekst

Pärige tõendi märgi kohandatud jagamistekst.

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

Näide

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

Vastus

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

Kui kohandatud jagamistekst puudub, tagastatakse vaikesõnum.

---

Saada tõendi e-kiri (avalik)

Saada tõendi teavituskiri avalikust otspunktist. Seda kasutab avalik jagamisleht.

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

Parameetrid

Parameeter	Tüüp	Kohustuslik	Kirjeldus
recipients	string	Jah	E-posti aadresside komadega eraldatud loend
message	string	Ei	E-kirjas sisalduv kohandatud sõnum

Näide

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

Vastus

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

See on ainus otspunkt, mis pakendab oma tulemuse { "statusCode", "info" } ümbrikku. Kõik teised otspunktid tagastavad oma sisu otse.

---

Kinnita väljaandja

Kinnita väljaandja, klõpsates väljaandja e-posti aadressile saadetud kinnituslingil. Sellele pääseb tavaliselt ligi kinnituskirjas oleva lingi kaudu, mitte otse kutsudes.

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

Parameetrid

Parameeter	Tüüp	Kirjeldus
guid	string	Väljaandja GUID
code	string	Kinnituskood

Vastus

Tagastab HTML-lehe, mis kinnitab, kas kinnitamine õnnestus või ebaõnnestus. See otspunkt on mõeldud brauseris avamiseks.