การยืนยันตัวตน

คำขอ API ทั้งหมดไปยัง badges.ninja ต้องมีการยืนยันตัวตน หน้านี้อธิบายวิธียืนยันตัวตนสำหรับคำขอของคุณ

Base URL

https://api.badges.ninja

endpoint ของ API ทั้งหมดอ้างอิงจาก base URL นี้

การยืนยันตัวตนด้วย API Key

วิธียืนยันตัวตนหลักคือ API key ที่ส่งผ่านเฮดเดอร์ X-Api-Key

การขอรับ API Key

จากแดชบอร์ด:

ลงชื่อเข้าใช้ที่ badges.ninja
ไปที่ API Keys ในแถบด้านข้าง
คลิก Create API Key
คัดลอกคีย์ (คีย์จะแสดงเพียงครั้งเดียว)

จาก API:

คุณยังสามารถจัดการ API key ผ่าน API ได้โดยใช้โทเค็น JWT จากขั้นตอนการยืนยันตัวตนของ Cognito แต่วิธีที่ง่ายที่สุดคือใช้แดชบอร์ด

การใช้ API Key ของคุณ

ใส่เฮดเดอร์ X-Api-Key ในทุกคำขอ:

bash

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

รูปแบบของ API Key

คีย์ใช้คำนำหน้า bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

รูปแบบคำขอ

คำขอ GET ส่งพารามิเตอร์เป็น query string
คำขอ POST และ PUT ส่ง JSON body ที่มีออบเจกต์ parameters
การตอบกลับทั้งหมดเป็น JSON พร้อม Content-Type: application/json

โครงสร้างคำขอ POST/PUT

json

{
  "parameters": {
    "name": "My Badge",
    "description": "A sample badge"
  }
}

ตัวอย่างคำขอ

bash

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "My Organization",
      "url": "https://example.com",
      "email": "admin@example.com"
    }
  }'

ตัวอย่างการตอบกลับ

json

{
  "issuerId": "https://api.badges.ninja/certify-badge/issuer/abc123-def456"
}

Endpoint สาธารณะ

บาง endpoint ไม่ต้องยืนยันตัวตน ได้แก่ endpoint ตรวจสอบสาธารณะ ภายใต้ /certify-badge/ ที่ให้ทุกคนตรวจสอบข้อมูลรับรองของตราสัญลักษณ์ดิจิทัลได้

การยืนยันตัวตน ​

Base URL ​

การยืนยันตัวตนด้วย API Key ​

การขอรับ API Key ​

การใช้ API Key ของคุณ ​

รูปแบบของ API Key ​

รูปแบบคำขอ ​

โครงสร้างคำขอ POST/PUT ​

ตัวอย่างคำขอ ​

ตัวอย่างการตอบกลับ ​

Endpoint สาธารณะ ​