跳转到内容

版本与兼容性

新集成使用 https://www.blast.fun/api/v1。URL 中的主版本决定 API 约定。OpenAPI 文档的 info.version 表示该约定的发布版本,openapi 字段表示规范格式版本;两者都不决定 HTTP 请求使用哪个版本。

打开 v1 参考 · 下载 v1 OpenAPI 文档

现有路由、必填字段、字段类型、单位、可空性、已记录的枚举值、参数含义、默认排序、分页行为、HTTP 状态和错误码保持兼容。文档规定为字符串的 ID 和最小单位金额仍为字符串,不要转换为 JavaScript 数字。

v1 内可新增端点和可选响应字段,客户端应忽略未知响应字段。改变现有字段含义或类型、增加必填请求参数、移除字段或路由,以及不兼容的枚举变更,均需新主版本。

修复错误和更新数据不会产生新 API 版本。限流及运行可用性另有说明,请遵守 Retry-After 并显式处理不可用数据。

破坏兼容的变更使用 /api/v2/...,并提供独立文档和迁移指南。在宣布的迁移期内,v1 继续运行。目前没有计划中的 v1 停用时间。在要求伙伴迁移前,我们会公布弃用日期、替代端点、迁移步骤和停止服务日期。

密钥及伙伴配额不绑定 URL 版本。切换版本或轮换密钥不会增加配额。密钥撤销完成后,立即在全部受支持的伙伴 URL 上失效。

分页游标只能用于产生它的端点、版本、过滤条件和排序。将游标视为不透明值,不要跨版本使用或自行构造。

现有 /api/social/... 和 /api/launchpad/... 合作伙伴端点继续使用原请求和响应格式,未被移除或重定向。Blast 前端继续使用这些 URL,以及已有认证与可见性规则。

新伙伴集成使用 v1。迁移已有集成时,只按下表修改路径前缀,密钥、查询参数和响应正文不变:

原 URL V1 URL
/api/social/presales 及已记录的子路径 /api/v1/presales 及相同子路径
/api/social/prices /api/v1/prices
/api/launchpad/discovery /api/v1/discovery
/api/launchpad/search /api/v1/search
/api/launchpad/market/... /api/v1/market/...

v1 始终要求 X-Blast-Partner-Key,即使浏览器已有 Blast 会话。它不授权访问页面、账户数据、写入或未记录路由。伙伴使用 v1 时,前端仍可保持私有。