Xác thực

Tất cả các yêu cầu API tới badges.ninja đều cần xác thực. Trang này giải thích cách xác thực các yêu cầu của bạn.

URL gốc

https://api.badges.ninja

Tất cả các điểm cuối API đều tính tương đối so với URL gốc này.

Xác thực bằng khóa API

Phương thức xác thực chính là khóa API được truyền trong header X-Api-Key.

Lấy khóa API

Từ bảng điều khiển:

Đăng nhập tại badges.ninja.
Vào mục API Keys trên thanh bên.
Nhấp Create API Key.
Sao chép khóa (khóa chỉ hiển thị một lần).

Từ API:

Khóa API cũng có thể được quản lý qua API bằng token JWT từ luồng xác thực Cognito. Cách đơn giản nhất là dùng bảng điều khiển.

Sử dụng khóa API

Thêm header X-Api-Key vào mọi yêu cầu:

bash

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

Định dạng khóa API

Khóa dùng tiền tố bws_:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Định dạng yêu cầu

Yêu cầu GET truyền tham số dưới dạng chuỗi truy vấn
Yêu cầu POST và PUT gửi nội dung JSON với đối tượng parameters
Mọi phản hồi trả về JSON với Content-Type: application/json

Cấu trúc yêu cầu POST/PUT

json

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

Yêu cầu ví dụ

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

Phản hồi ví dụ

json

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

Điểm cuối công khai

Một số điểm cuối không cần xác thực. Đó là các điểm cuối xác minh công khai dưới /certify-badge/, cho phép bất kỳ ai xác minh chứng chỉ huy hiệu.

Xác thực ​

URL gốc ​

Xác thực bằng khóa API ​

Lấy khóa API ​

Sử dụng khóa API ​

Định dạng khóa API ​

Định dạng yêu cầu ​

Cấu trúc yêu cầu POST/PUT ​

Yêu cầu ví dụ ​

Phản hồi ví dụ ​

Điểm cuối công khai ​