Public Verification

Ang mga endpoint na ito ay public at hindi nangangailangan ng authentication. Pinapayagan nila ang sinuman na mag-verify ng badge credentials at kunin ang Open Badge v2.0 JSON data.

Lahat ng endpoint ay relative sa https://api.badges.ninja.

Kunin ang Issuer

Kunin ang Open Badge v2.0 Issuer Profile JSON para sa isang naibigay na issuer.

GET /certify-badge/issuer/{guid}

Halimbawa

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

Response

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

---

Kunin ang Badge

Kunin ang Open Badge v2.0 BadgeClass JSON para sa isang naibigay na badge.

GET /certify-badge/badge/{guid}

Halimbawa

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

Response

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

---

Kunin ang Award

Kunin ang Open Badge v2.0 Assertion JSON para sa isang naibigay na award.

GET /certify-badge/award/{guid}

Halimbawa

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

Response

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

Mga Tala

• Ang email ng tatanggap ay hashed (SHA-256) para sa privacy, sumusunod sa Open Badge spec.
• Ang mga response ay naka-cache nang 1 oras (Cache-Control: public, max-age=3600).

---

Kunin ang Award Share Text

Kunin ang custom share text para sa badge ng isang award.

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

Halimbawa

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

Response

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

Kung walang naitakdang custom share text, default na mensahe ang nire-return.

---

Magpadala ng Award Email (Public)

Magpadala ng award notification email mula sa public endpoint. Ginagamit ito ng public share page.

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

Mga Parameter

Parameter	Uri	Kailangan	Paglalarawan
recipients	string	Oo	Listahan ng email address na hinati ng kuwit
subject	string	Hindi	Subject ng email
message	string	Hindi	Custom message para isama sa email

Halimbawa

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

Response

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

---

I-verify ang Issuer

I-verify ang isang issuer sa pamamagitan ng pag-click sa verification link na ipinadala sa email ng issuer. Karaniwang ina-access ito sa pamamagitan ng link sa verification email, hindi tinatawag nang direkta.

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

Mga Parameter

Parameter	Uri	Paglalarawan
guid	string	Ang issuer GUID
code	string	Ang verification code

Response

Nagre-return ng HTML page na nagkukumpirma na nagtagumpay o nabigo ang verification. Ang endpoint na ito ay dinisenyo para buksan sa browser.