API เหรียญตรา

จัดการเทมเพลตเหรียญตรา — คุณวุฒิที่คุณมอบให้ผู้รับ

จุดสิ้นสุดทั้งหมดต้องการการยืนยันตัวตนผ่านส่วนหัว X-Api-Key ดู การยืนยันตัวตน

สร้างเหรียญตรา

สร้างเหรียญตราใหม่ภายใต้ผู้ออกที่ผ่านการยืนยัน

POST /badges

พารามิเตอร์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
name	string	ใช่	ชื่อเหรียญตรา
description	string	ใช่	สิ่งที่เหรียญตราเป็นตัวแทน
criteria	string	ใช่	สิ่งที่ผู้รับทำเพื่อให้ได้รับเหรียญตรานี้
image	string	ใช่	รูปภาพที่เข้ารหัส Base64 (PNG หรือ JPG)
issuerId	string	ใช่	ID ของผู้ออกที่ผ่านการยืนยัน

ตัวอย่าง

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

การตอบกลับ

{
  "statusCode": 200,
  "info": {
    "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"

การตอบกลับ

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "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"
      }
    ]
  }
}

---

อัปเดตเหรียญตรา

อัปเดตเหรียญตราที่มีอยู่ เฉพาะฟิลด์ที่คุณให้จะถูกเปลี่ยน

PUT /badges/{badgeId}

พารามิเตอร์

พารามิเตอร์	ประเภท	จำเป็น	คำอธิบาย
badgeId	string	ใช่	ID เหรียญตรา (พารามิเตอร์เส้นทาง)
name	string	ไม่	ชื่อเหรียญตราใหม่
description	string	ไม่	คำอธิบายใหม่
criteria	string	ไม่	เกณฑ์ใหม่
image	string	ไม่	รูปภาพที่เข้ารหัส Base64 ใหม่

ตัวอย่าง

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

การตอบกลับ

{
  "statusCode": 200,
  "info": {
    "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:"
    }
  }'

การตอบกลับ

{
  "statusCode": 200,
  "info": {
    "updated": true
  }
}

---

ลบเหรียญตรา

ลบเหรียญตรา เหรียญตราต้องไม่มีรางวัล

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"

การตอบกลับ

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

ข้อผิดพลาด

• 400 — เหรียญตรามีรางวัลและไม่สามารถลบได้
• 404 — ไม่พบเหรียญตรา