Xác thực và hạn chế tốc độ

Tất cả các điểm kết thúc của nền tảng mở được đồng nhất xác thực thông qua khóa API. Trang này giải thích rõ ràng ba cách viết Tkens, hạn chế tỷ lệ gói và ngữ nghĩa của trả lời lỗi.

Ba Phương pháp ghi xác thực

1. Tác quyền: Bearer (tiểu thức)

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Phương pháp ghi chuẩn nhất, được hỗ trợ bởi mọi SDK theo mặc định. Môi trường sản xuất được ưa thích hơn.

2.X-API-Key Header

curl https://braidrun.com/api/v1/workflows \
  -H "X-API-Key: dyk_<id>_<secret>"

Tùy chọn này cho trường hợp ủy nhiệm của một số mạng đóng không thể gửi tới Đầu đề Tác quyền. Tương đương với Bearer.

3. Truy vấn tham số: api key=(chỉ trong trường hợp không thể ghi)

https://braidrun.com/api/webhook-trigger/approval/appr-123/approve?api_key=dyk_<id>_<secret>

Ưu tiên

1. Authorization: Bearer dyk_…
2. X-API-Key: dyk_…
3. ?api_key=dyk_…

Cố gắng từ trên xuống dưới và ngừng phân tích khi bạn tìm thấy một cái không rỗng.

Giới hạn tốc độ

Mỗi khóa ARI có hai giới hạn trên của "thường là phút" và "một lần", mà được tự động áp dụng theo gói chủ chìa khóa. Mỗi chìa khóa có một chỉ tiêu độc lập và không chia sẻ với các chìa khóa khác trong cùng một tài khoản.

Bảng so sánh gói

Ngữ nghĩa cửa sổ

• cửa sổ phút · Dùng khoảng thời gian giai đoạn là phím, và ranh giới tự động được đặt lại mỗi phút (không phải cửa sổ trượt bắt đầu từ lần gõ đầu)
• ngày (cửa sổ ngày) · Dùng ngày tháng UTC là phím, tự động đặt lại lúc 00:00 UTC mỗi ngày

Khi đến giới hạn

HTTP/1.1 429 Too Many Requests
Retry-After: 38
X-RateLimit-Limit: 60
X-RateLimit-Window: minute
Content-Type: application/json

{
  "error": "Rate limit exceeded",
  "window": "minute",
  "limit": 60,
  "retryAfterSeconds": 38
}

Khách hàng nên:

• Đọc lại đầu trang sau (số giây), chậm trong khoảng thời gian tương ứng và thử lại
• X-RateLimit-Window Nói cho bạn biết cửa sổ nào đã bị tấn công ( Phút/ ngày)
• & Phản đối hiển thị và hoảng loạn; đừng thử lại ngay sau khi nhận được 429

Mã Trả lời HTTP