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

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

URL พื้นฐาน

https://api.badges.ninja

จุดสิ้นสุด API ทั้งหมดสัมพันธ์กับ URL พื้นฐานนี้

การยืนยันตัวตนด้วยคีย์ API

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

การรับคีย์ API

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

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

จาก API:

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

การใช้คีย์ API ของคุณ

ระบุส่วนหัว X-Api-Key ในทุกคำขอ:

bash

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

รูปแบบคีย์ API

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

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

รูปแบบคำขอ

คำขอ GET ส่งพารามิเตอร์เป็นสตริงสอบถาม
คำขอ POST และ PUT ส่งเนื้อหา JSON พร้อมวัตถุ 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

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

ขีดจำกัดอัตรา

คำขอ API อยู่ภายใต้การจำกัดอัตรา หากคุณเกินขีดจำกัด คุณจะได้รับการตอบกลับ 429 Too Many Requests รอสักครู่แล้วลองอีกครั้ง

จุดสิ้นสุดสาธารณะ

จุดสิ้นสุดบางอย่างไม่ต้องการการยืนยันตัวตน เป็น จุดสิ้นสุดการตรวจสอบสาธารณะ ภายใต้ /certify-badge/ ที่ให้ใครก็ตามตรวจสอบคุณวุฒิเหรียญตรา

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

URL พื้นฐาน ​

การยืนยันตัวตนด้วยคีย์ API ​

การรับคีย์ API ​

การใช้คีย์ API ของคุณ ​

รูปแบบคีย์ API ​

รูปแบบคำขอ ​

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

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

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

ขีดจำกัดอัตรา ​

จุดสิ้นสุดสาธารณะ ​