徽章 API

管理徽章模板 — 你颁发给接收者的凭证。

所有端点都需要通过 X-Api-Key 头进行认证。参阅 认证。

创建徽章

在已验证的颁发者下创建一枚新徽章。

POST /badges

参数

参数	类型	必填	说明
name	string	是	徽章标题
description	string	是	徽章代表的含义
criteria	string	是	接收者为获得它做了什么
image	string	是	Base64 编码图片(PNG 或 JPG)
issuerId	string	是	已验证颁发者的 ID
shareText	string	否	该徽章的默认社交分享文案。支持 、 和 占位符。省略时回退到内置默认值。
designJson	string	否	序列化的徽章设计器文档,存储后可供日后逐层重新编辑该徽章。

示例

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

响应

{
  "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
}

说明

• 颁发者必须先完成验证才能创建徽章。
• 图片会上传到 IPFS 进行永久存储。

---

列出徽章

获取你创建的所有徽章。

GET /badges

示例

curl -X GET https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here"

响应

[
  {
    "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..." },
    "image": "https://ipfs.ninja/ipfs/Qm...",
    "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
    "timestamp": "2025-01-15T10:30:00.000Z"
  }
]

---

获取徽章

获取单枚徽章,包含其分享文案与序列化的徽章设计器文档(designJson)。这是编辑徽章弹窗用来重新载入各图层的端点;列表端点会省略 designJson 以保持响应精简。

GET /badges/{badgeId}

参数

参数	类型	必填	说明
badgeId	string	是	徽章 ID(路径参数)

示例

curl -X GET https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

响应

{
  "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..." },
  "image": "https://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "shareText": "Excited to share that I just received the \"{{badge_name}}\" certification!",
  "designJson": "{ ...serialized designer document... }",
  "timestamp": "2025-01-15T10:30:00.000Z"
}

分享文案始终会包含在内。更轻量的 GET /badges?badgeId={id} 列表变体返回相同的文档但不含 designJson,且仅在以 includeShareText=true 调用时才包含分享文案。

---

更新徽章

更新已存在的徽章。仅会修改你提供的字段。

PUT /badges/{badgeId}

参数

参数	类型	必填	说明
badgeId	string	是	徽章 ID(路径参数)
name	string	否	新徽章标题
description	string	否	新描述
criteria	string	否	新的获取标准
image	string	否	新的 Base64 编码图片
designJson	string	否	新的序列化徽章设计器文档。

示例

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

响应

{
  "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "updated": true
}

---

更新分享文案

设置当接收者在社交媒体上分享这枚徽章时显示的自定义文案。

PUT /badges/{badgeId}/share-text

参数

参数	类型	必填	说明
badgeId	string	是	徽章 ID(路径参数)
text	string	是	分享文案(不允许 HTML)

示例

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

响应

{
  "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-..."
}

---

删除徽章

删除徽章。该徽章必须没有颁发记录。

DELETE /badges/{badgeId}

示例

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

响应

返回一个纯文本确认字符串:

"badge has been deleted"

错误

• 400 — 徽章仍有已颁发的记录:"This badge still has issued awards. Remove them first from the Awards page (revoke or delete each award), then delete the badge."
• 404 — 徽章未找到