Bitculator

Chính sách

Chính sách API

Data API được đánh phiên bản thế nào, việc ngừng hỗ trợ được công bố ra sao và kéo dài bao lâu, và cách báo cáo một vấn đề bảo mật.

Phiên bản

API được đánh phiên bản trong đường dẫn: mọi endpoint đều nằm dưới /api/v1. info.version của hợp đồng (hiện là 1.1.0) đi theo nhật ký thay đổi: số minor tăng khi có thứ được thêm vào, số patch tăng khi có thứ được sửa, và một phiên bản đường dẫn mới (/api/v2) là cách duy nhất để một thay đổi phá vỡ tương thích được phát hành.

Tám SDK chính thức bám theo API: một endpoint mới là một bản phát hành minor của SDK, một endpoint bị gỡ bỏ hoặc đổi tên là một bản phát hành major.

Điều gì được tính là phá vỡ tương thích

Những điều này không bao giờ xảy ra bên trong một phiên bản đường dẫn:

  • Gỡ bỏ hoặc đổi tên một endpoint, một tham số truy vấn hay một trường phản hồi.
  • Thay đổi kiểu của một trường, hoặc quy tắc rằng giá, tỷ giá và nguồn cung là chuỗi thập phân.
  • Thay đổi envelope { data, meta }, envelope lỗi hay ý nghĩa của một mã lỗi hiện có.
  • Hạ một giới hạn tốc độ hoặc hạn ngạch mà một gói đã có.

Những điều này có thể xảy ra bất cứ lúc nào và được công bố trong nhật ký thay đổi:

  • Endpoint, tham số truy vấn và trường phản hồi mới.
  • Mã lỗi mới cho các tình huống mới - luôn khớp theo error.code, không bao giờ theo message.
  • Giá trị mới trong các danh sách mà tài liệu tham khảo cho biết có thể mở rộng, chẳng hạn tên sự kiện và tên chỉ báo.
  • Giới hạn và hạn ngạch cao hơn.

Ngừng hỗ trợ

Khi một endpoint, tham số hay trường được lên lịch gỡ bỏ, việc này được công bố trong nhật ký thay đổi và qua email tới mọi chủ sở hữu key, và kể từ ngày đó endpoint trả về các header DeprecationSunset (RFC 9745, RFC 8594) nêu rõ ngày gỡ bỏ. Hợp đồng OpenAPI đánh dấu nó bằng deprecated: true.

Việc gỡ bỏ diễn ra không sớm hơn sáu tháng sau khi công bố. Một phiên bản đường dẫn mới chạy song song với phiên bản trước ít nhất sáu tháng trước khi phiên bản cũ được ngừng theo cùng cách.

Hiện không có gì bị ngừng hỗ trợ hay được lên lịch gỡ bỏ.

Giới hạn và sử dụng hợp lý

Giới hạn burst mỗi phút và hạn ngạch hàng tháng là một phần của gói của bạn, được báo trên mọi phản hồi trong các header X-RateLimit-*X-Quota-* và được ghi trong tài liệu tham khảo. Nâng một giới hạn không bao giờ là phá vỡ tương thích; hạ một giới hạn bên trong một gói thì có, và tuân theo lộ trình ngừng hỗ trợ.

Công bố có trách nhiệm

Nếu bạn tin rằng mình đã tìm thấy một lỗ hổng bảo mật trong bitculator.com, Data API, máy chủ MCP hay các SDK, hãy gửi email tới contact@bitculator.com kèm URL hoặc endpoint bị ảnh hưởng, các bước tái hiện và tác động bạn nhận thấy. Bạn sẽ nhận được phản hồi trong vòng ba ngày làm việc.

Vui lòng giữ kín báo cáo cho đến khi lỗi được khắc phục, không truy cập hay sửa đổi dữ liệu không thuộc về bạn, và không thực hiện tấn công từ chối dịch vụ hay quét tự động nhằm vào môi trường production. Các báo cáo được gửi với thiện chí theo những điều khoản này sẽ không bị xử lý pháp lý. Không có chương trình thưởng lỗi trả tiền; chúng tôi ghi nhận công lao khi được yêu cầu.

Cùng thông tin liên hệ này được công bố ở dạng máy đọc được tại /.well-known/security.txt (RFC 9116).

Trạng thái và sự cố

Trạng thái trực tiếp của các thành phần, các sự cố đang mở và các đợt gián đoạn trong 30 ngày qua có trên trang trạng thái và tại /status.json.