Xác thực
CoinBoss API là API công khai. Bạn không cần tài khoản hay khóa API để gọi bất kỳ endpoint dữ liệu nào.
Không cần khóa
Gọi bất kỳ endpoint nào trong danh mục bằng một lệnh HTTPS GET thông thường. Yêu cầu ẩn danh bị giới hạn theo địa chỉ IP: 1200 yêu cầu mỗi phút.
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC"Khóa API tùy chọn
Nếu nhiều dịch vụ của bạn dùng chung một địa chỉ IP, hoặc bạn gọi từ một mạng có địa chỉ thay đổi, bạn có thể tạo khóa trong tài khoản và gửi nó trong header CB-API-KEY. Yêu cầu có khóa hợp lệ sẽ được tính vào hạn mức của khóa thay vì của địa chỉ IP.
- Khóa được tạo và thu hồi tại trang khóa API trong tài khoản của bạn. Cần có địa chỉ email đã xác minh.
- Khóa đầy đủ chỉ hiển thị một lần, lúc tạo. Hệ thống chỉ lưu giá trị băm nên không thể hiển thị lại khóa.
- Mỗi tài khoản có tối đa năm khóa đang hoạt động.
- Khóa không tồn tại hoặc đã bị thu hồi sẽ bị bỏ qua: yêu cầu được phục vụ như yêu cầu ẩn danh và tính vào hạn mức của địa chỉ IP.
Yêu cầu kèm khóa
curl -s "https://www.coinboss.com/api/sd/oi?coin=BTC" \
-H "CB-API-KEY: $COINBOSS_API_KEY"Các bậc giới hạn tần suất
Mọi bậc đều trả về cùng một dữ liệu. Trong giai đoạn miễn phí hiện tại, lưu lượng ẩn danh và mọi khóa đều được phục vụ ở bậc cao nhất.
| Bậc | Yêu cầu mỗi phút | |
|---|---|---|
| hobbyist | 30 | |
| startup | 80 | |
| standard | 300 | |
| professional | 1200 | đang áp dụng cho mọi người |
Giữ an toàn cho khóa
- Hãy coi khóa như mật khẩu. Lưu khóa trong biến môi trường hoặc kho bí mật, không đặt trong mã nguồn.
- Không nhúng khóa vào trang web, tiện ích mở rộng trình duyệt hay ứng dụng di động. Bất cứ thứ gì được phát hành xuống phía client đều có thể bị người dùng đọc được. Hãy gọi API từ máy chủ của bạn, hoặc gọi ẩn danh từ trình duyệt.
- Thu hồi khóa ngay khi bạn nghi ngờ nó đã bị lộ và tạo khóa mới.
- CoinBoss không bao giờ yêu cầu khóa API của sàn. Dữ liệu được thu thập từ các endpoint công khai của sàn; API này không cần và cũng không nhận bất kỳ thông tin xác thực nào của sàn.
Gọi từ trình duyệt
Phản hồi có kèm Access-Control-Allow-Origin: * nên có thể gọi các endpoint dữ liệu từ mọi origin web. Các header X-Request-Id, X-Cache và X-RateLimit-* được mở cho script đọc.
Endpoint tài khoản
Các endpoint dưới /api/user và /api/auth phục vụ trải nghiệm trên website sau khi đăng nhập (danh sách theo dõi, tùy chọn cá nhân, quản lý khóa). Chúng dùng phiên của trang, không thuộc API dữ liệu công khai và không được liệt kê trong danh mục.