Xác thực

Mọi yêu cầu API đến 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 cơ sở

https://api.badges.ninja

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

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

Phương thức xác thực chính là một 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 Khóa API trên thanh bên.
Nhấp Tạo khóa API.
Sao chép 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 của bạn từ luồng xác thực Cognito. Xem bảng điều khiển để có cách tiếp cận đơn giản nhất.

Dùng khóa API của bạn

Đưa 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 thân JSON có đố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

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

Giới hạn tần suất

Các yêu cầu API chịu giới hạn tần suất. Nếu vượt quá giới hạn, bạn sẽ nhận phản hồi 429 Too Many Requests. Hãy chờ vài giây rồi thử lại.

Đ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 thực công khai dưới /certify-badge/ cho phép bất kỳ ai xác thực chứng chỉ huy hiệu.

Xác thực ​

URL cơ sở ​

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

Lấy khóa API ​

Dùng khóa API của bạn ​

Đị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ụ ​

Giới hạn tần suất ​

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