Khóa API

Khóa API cho phép bạn truy cập REST API của badges.ninja theo cách lập trình. Hãy dùng chúng để tự động tạo, cấp và quản lý huy hiệu từ ứng dụng của bạn.

Tạo khóa API

1. Mở trang Khóa API từ thanh bên.
2. Nhấp Tạo khóa API. Biểu mẫu bên trong sẽ mở ra:

3. Đặt tên cho khóa rồi nhấp Tạo. Khóa đầy đủ sẽ hiện một lần trên một biểu ngữ màu xanh:

4. Sao chép khóa ngay lập tức — khóa chỉ hiện một lần. Nếu bạn làm mất, bạn sẽ phải tạo khóa mới. Sau khi đóng biểu ngữ, chỉ tiền tố được lưu:

Phạm vi truy cập

Khi tạo một khóa, bạn có thể đặt nó thành chỉ-đọc hoặc để nó có toàn quyền:

Phạm vi	Cho phép
Toàn quyền (mặc định)	Đọc và ghi — liệt kê dữ liệu cũng như tạo, cấp, cập nhật hoặc xóa.
Chỉ-đọc	Chỉ các yêu cầu GET an toàn. Bất kỳ yêu cầu thay đổi dữ liệu nào (POST, PUT, PATCH, DELETE) đều bị từ chối với 403 Forbidden.

Hãy dùng khóa chỉ-đọc cho những tích hợp chỉ cần đọc dữ liệu của bạn (báo cáo, bảng điều khiển, sao lưu) để một khóa bị lộ không thể thay đổi bất cứ thứ gì. Tích chọn Read-only key trong biểu mẫu tạo khóa; các khóa chỉ-đọc hiển thị một huy hiệu Read-only trong danh sách. Các khóa được tạo trước khi có phạm vi truy cập vẫn giữ toàn quyền.

Định dạng khóa

Khóa API dùng tiền tố bws_ theo sau là chuỗi hex dài 32 ký tự:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

Dùng khóa API trong yêu cầu

Đưa khóa API vào header X-Api-Key của mỗi yêu cầu API:

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

Xem trang Xác thực để có chi tiết đầy đủ.

Hạn mức khóa theo gói

Số lượng khóa API bạn có thể tạo tùy theo gói:

Gói	Giới hạn khóa API
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

Xóa khóa

1. Mở trang Khóa API.
2. Tìm khóa bạn muốn xóa.
3. Nhấp Xóa.
4. Xác nhận việc xóa.

Sau khi xóa, khóa sẽ ngừng hoạt động ngay lập tức. Bất kỳ ứng dụng nào đang dùng khóa đó sẽ nhận lỗi xác thực.