Tham chiếu · API máy chủ
Tổng quan API
Xác thực, CORS, giới hạn tần suất, và hình dạng lỗi.
Mọi endpoint phía máy chủ dùng chung các quy ước sau.
Xác thực#
| Endpoint | Xác thực bằng | Header |
|---|---|---|
/api/v1/collect | Khoá công khai trong body | - |
/api/v1/verdict | Khoá bí mật của site | x-api-key |
/api/v1/verdict-public | Khoá công khai (chỉ để nhận diện) | x-site-key |
/api/v1/payments | Khoá bí mật của site | x-api-key |
/api/v1/blocklist | Token vận hành | x-collect-token |
/api/v1/visits | Token vận hành | x-collect-token |
Khoá công khai không phải một thông tin xác thực. Nó nằm trong mọi trang chạy SDK. Nơi nào nó xuất hiện, nó chỉ để nhận diện site, không phải để cấp quyền.
CORS#
/api/v1/collect và /api/v1/verdict-public gửi header CORS để trình duyệt gọi được, giới hạn theo danh sách origin của site.
/api/v1/verdict cố ý không gửi header CORS nào. Trình duyệt không được phép tới được nó: khoá công khai nằm trong mọi trang, và nếu endpoint này chấp nhận nó thì bất kỳ ai cũng hỏi được về bất kỳ ai.
Hình dạng lỗi#
{ "error": "Unknown or missing site secret" }| Mã | Nghĩa |
|---|---|
400 | Body không hợp lệ |
401 | Khoá sai hoặc thiếu |
403 | Origin không được phép |
404 | Không tìm thấy |
429 | Quá tần suất |
503 | Một thành phần chưa được cấu hình |
Không bộ nhớ đệm#
Mọi route trả về Cache-Control: no-store.
Fail open#
Nếu một lệnh gọi lỗi hoặc timeout, hãy cho request của bạn đi tiếp. Một dịch vụ bên ngoài nằm trên đường đi quan trọng mà fail closed thì thời gian chết của họ là thời gian chết của bạn.