公開驗證

這些端點為公開,無需驗證。它們讓任何人都能驗證徽章憑證,並取得 Open Badge v2.0 JSON 資料。

所有端點皆相對於 https://api.badges.ninja。

取得頒發者

取得指定頒發者的 Open Badge v2.0 Issuer Profile JSON。

GET /certify-badge/issuer/{guid}

範例

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

回應

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

---

取得徽章

取得指定徽章的 Open Badge v2.0 BadgeClass JSON。

GET /certify-badge/badge/{guid}

範例

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

回應

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

---

取得頒發

取得指定頒發的 Open Badge v2.0 Assertion JSON。

GET /certify-badge/award/{guid}

範例

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

回應

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

備註

• 接收者電子郵件以 SHA-256 雜湊以保障隱私,遵循 Open Badge 規格。
• 回應快取 1 小時(Cache-Control: public, max-age=3600)。

---

取得頒發分享文案

取得某筆頒發所屬徽章的自訂分享文案。

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

範例

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

回應

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

若未設定自訂分享文案,會傳回預設訊息。

---

寄送頒發電子郵件(公開)

從公開端點寄送頒發通知電子郵件。此端點由公開分享頁使用。

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

參數

參數	型別	必填	說明
recipients	string	是	以逗號分隔的電子郵件清單
subject	string	否	電子郵件主旨
message	string	否	要附加在電子郵件中的自訂訊息

範例

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

回應

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

---

驗證頒發者

透過點按寄至頒發者電子郵件的驗證連結以驗證頒發者。通常是透過驗證電子郵件中的連結存取,而非直接呼叫。

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

參數

參數	型別	說明
guid	string	頒發者 GUID
code	string	驗證碼

回應

傳回一個 HTML 頁面,確認驗證是否成功。此端點設計用於在瀏覽器中開啟。