跳到内容
API 文档
Esc
切换打开⌘J预览

契约变更日志

Darkroom API 的契约级变更记录,每条带 breaking / additive / fix 分级。

本页记录会影响集成代码的接口契约变更,包括字段、状态码、认证方式和端点。面向商家的功能更新请参阅产品更新;两类记录分别维护,以便读者快速识别与自身相关的变化。

变更分级

级别 定义 是否需要集成方调整
breaking 删字段 / 改字段语义 / 改状态码含义 / 收紧校验
additive 加可选字段 / 加端点 / 加 scope
fix 修复与文档不符的行为 否,但需说明原行为

版本策略

  • URL 携带 major 版本https://api.darkroom.net/v2/。将来 v3 与 v2 并存,不做隐式升级。
  • 为什么当前 API 使用 v2:v1 是冻结兼容面,v2 使用 OAuth 2.0、标准 HTTP 状态码和结构化 JSON,并作为所有新接入的目标版本。
  • minor 变更不改 URL,只在本页标注。

尚未开放

Darkroom API v1 已进入兼容性维护阶段,其历史变更不在本页记录。

文档变更记录

接口尚未开放,以下内容仅记录文档调整,不代表接口契约发生变化。

2026-07-29

  • API 文档调整为以 v2 为主要版本:认证采用 OAuth 2.0 client_credentials,base URL 为 https://api.darkroom.net/v2,并补充沙盒地址和双层限流规则。
  • 移除未对外提供的 HMAC 认证方案,避免与计划开放的正式接口契约混淆。

2026-07-28

  • 文档站结构重组:API 文档从商家帮助中心拆出为独立站点,地址由 /docs/developer-api/* 改为 /docs/api/*,旧地址 301 跳转。

2026-07-27

  • 首次发布订单接口草案和 Darkroom API v1 兼容性说明。