GET公开接口

获取最新公告

获取一条最新公告,常用于首页公告位。

URL

/api/v1/public/{projectKey}/announcements/latest

鉴权方式

无需鉴权

请求参数

Path 参数

名称类型必填说明
projectKeystring是项目主键 project_key(大小写不敏感)

Query 参数

名称类型必填说明
platformwindows | linux | macos | ios | android | web | others否平台过滤(仅返回该平台或全平台公告)
platform_versionstring否客户端系统版本明细(等价于 `x-verhub-platform-version` 请求头,优先级低于请求头)。 仅用于请求统计,不影响接口返回内容。
versionstring否客户端当前版本号,用来筛掉不在可见版本范围内的公告。 先当可比较版本号解析,解析不了再按 `version` 去该项目的版本表精确查一次, 取那条版本登记的可比较版本号——客户端报自己展示用的版本号即可,不必先自行换算。 **不传(或两条路都解析不出)时,所有设了可见版本范围的公告都不会返回。** 没设范围的公告不受影响,照常返回。
localestring否语言偏好。命中该项目注册过的语言(匹配大小写不敏感)且该公告存有对应译文时, `title` / `content` 返回译文,`locale` 字段标出实际语言; 以下三种情况一律返回公告的默认内容且 `locale` 为 `null`:不传本参数、 传了项目未注册的语言、该公告没有这个语言的译文。 提交格式不设限:`en-US`、`en_US`、`en(US)` 视为同一个标签(`_` 与括号等同 `-`, 大小写不敏感);不含分隔符的写法整串比对。没命中时不报错,返回默认内容,并在 返回对象上附 `locale_message` 说明提交的语言未命中。

Header 参数

名称类型必填说明
x-verhub-platformwindows | linux | macos | ios | android | web | others否客户端平台声明,仅用于请求统计,不影响接口返回内容。 识别优先级:本请求头 > query 参数 `platform` > 请求体 `platform` 字段 > User-Agent 推断。 取值大小写不敏感,无法识别时统计为 OTHERS。 具体系统版本请用 `x-verhub-platform-version` 单独提交;若把版本混在本字段里 (如 `Windows 11`、`ubuntu 24.04`),服务端会拆开,平台与版本分别入库。 建议 SDK 显式声明本请求头:服务端调用的 User-Agent 往往不可靠。
x-verhub-platform-versionstring否客户端系统版本明细,仅用于请求统计,不影响接口返回内容。 自由文本,如 `11`、`ubuntu 24.04`、`26`;超过 32 字符视为无效直接丢弃。 识别优先级:本请求头 > query 参数 `platform_version` > 请求体 `platform_version` 字段 > 从 `platform` 中拆出的版本 > User-Agent 推断。
x-verhub-client-timestring否客户端发出请求时的本地时间,ISO 8601 并带显式 UTC 偏移,官方 SDK 默认附带。 仅用于统计,不影响接口返回内容:偏移让请求与事件热力图按用户当地时间折叠 (没带时按来源国家的代表时区近似);与服务端接收时间的差值用于校正同一批 事件的 `occurred_at`(偏差不足 60 秒视为网络延迟,不校正)。 缺偏移、偏移超出 UTC-12:00 至 UTC+14:00 或不是 15 分钟整数倍的取值按未上报处理,不会报错。

该接口无需请求体。

响应示例

200 响应

{
  "id": "ann-001",
  "title": "系统维护通知",
  "content": "平台将于本周六 02:00-04:00 停机维护。",
  "is_pinned": true,
  "is_hidden": false,
  "platforms": [
    "windows",
    "web"
  ],
  "author": "运维团队",
  "min_comparable_version": "2.0.0",
  "max_comparable_version": null,
  "locale": null,
  "published_at": 1760000000,
  "created_at": 1760000000,
  "updated_at": 1760000000
}
GET

Try It Out

请求 URL 预览

/api/v1/public/verhub/announcements/latest?version=2.1.0&locale=en-US