Bitculator
开发者控制台

政策

API 政策

Data API 如何进行版本管理、弃用如何公布及持续多久，以及如何报告安全问题。

版本管理

API 的版本体现在路径中：每个端点都位于 /api/v1 之下。契约的 info.version（当前为 1.1.0）跟随更新日志：有新增时次版本号递增，有修复时补丁版本号递增，而破坏性变更只会通过新的路径版本（/api/v2）发布。

八个官方 SDK 与 API 保持同步：新增端点对应 SDK 的一次次版本发布，移除或重命名端点则对应一次主版本发布。

哪些算作破坏性变更

以下情况绝不会在同一路径版本内发生：

  • 移除或重命名端点、查询参数或响应字段。
  • 更改字段类型，或更改“价格、汇率与供应量均为十进制字符串”这条规则。
  • 更改 { data, meta } 信封、错误信封或现有错误码的含义。
  • 调低某个套餐已经拥有的速率限制或配额。

以下情况随时可能发生，并会在更新日志中公布：

  • 新的端点、查询参数与响应字段。
  • 针对新情况的新错误码 - 请始终根据 error.code 匹配，绝不要根据消息文本匹配。
  • 参考文档中注明可能扩展的列表新增取值，例如事件名称与指标名称。
  • 更高的限制与配额。

弃用

当某个端点、参数或字段计划被移除时，会在更新日志中公布并邮件通知每一位密钥所有者；自当天起，该端点会返回标明移除日期的 Deprecation 与 Sunset 响应头（RFC 9745、RFC 8594）。OpenAPI 契约则以 deprecated: true 标记它。

移除最早在公布六个月后进行。新的路径版本会与上一版本并行运行至少六个月，之后旧版本以同样的方式停用。

当前没有任何已弃用或计划移除的内容。

限制与合理使用

每分钟突发限制与月度配额是你套餐的一部分，会在每个响应的 X-RateLimit-* 与 X-Quota-* 响应头中报告，并记录在参考文档中。调高限制绝不属于破坏性变更；在套餐内调低限制则属于，并遵循弃用时间表。

负责任的披露

如果你认为自己在 bitculator.com、Data API、MCP 服务器或 SDK 中发现了安全漏洞，请发送邮件至 contact@bitculator.com，附上受影响的 URL 或端点、复现步骤以及你观察到的影响。我们会在三个工作日内回复。

请在问题修复前对报告保密，不要访问或篡改不属于你的数据，也不要对生产环境发起拒绝服务攻击或自动化扫描。在这些条款下善意提交的报告不会遭到法律追究。我们没有付费漏洞赏金计划；如有需要可署名致谢。

同一联系方式也以机器可读形式发布在 /.well-known/security.txt（RFC 9116）。

状态与事件

各组件的实时状态、进行中的事件以及过去 30 天的故障记录，见状态页与 /status.json。