公開検証

これらのエンドポイントは公開されており、認証を必要としません。誰でもバッジ資格を検証し、Open Badge v2.0 JSON データを取得できます。

すべてのエンドポイントは https://api.badges.ninja からの相対パスです。

発行者の取得

指定した発行者の Open Badge v2.0 発行者プロフィール 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"
  }
}

注意

• Open Badge 仕様に従い、プライバシー保護のため受領者メールは SHA-256 でハッシュ化されます。
• レスポンスは 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 ページを返します。このエンドポイントはブラウザで開かれることを想定しています。