UIED Developers

UIED 内容开放接口

为合作网站、内容聚合服务和 RSS 阅读器提供已发布文章流。接口是否开放及可访问分类由站点运营方配置。

查看 JSON 查看 RSS OpenAPI JSON

概览

所有接口均为只读 GET 请求，仅返回已经发布的文章。接口关闭、格式关闭或分类不在开放范围时会返回 403。

内容范围: 已发布文章和其基础作者、分类、互动统计
响应格式: JSON 或标准 RSS 2.0 XML
跨域访问: 支持浏览器跨域 GET、HEAD 与 OPTIONS 预检

快速接入

合作方可以直接将下方规范地址导入 Apifox、Postman 或 Swagger UI，无需手工创建接口。

https://www.uied.cn/api/open/v1/openapi.json

在接口工具中选择“导入 OpenAPI”，粘贴上面的 JSON 地址。
JSON API 按概要接口的 jsonAuthRequired 判断是否需要 Key；RSS 始终免 Key。
服务端请求使用 X-API-Key，按 pagination.totalPages 分页同步。
遇到 429 时读取 Retry-After，等待后再重试。

JSON API

分页读取文章流，适合合作网站同步列表、构建资讯模块或进行服务端聚合。

GET

https://www.uied.cn/api/open/v1/posts

参数	说明
`page`	页码，默认 1。
`per_page`	每页条数，实际最大值由后台控制。
`categories`	逗号分隔的分类 ID，例如 `12,18`。
`category_slug`	单个分类别名。
`orderby`	排序字段，默认 `date`。
`order`	排序方向，默认 `DESC`。

RSS 订阅

适合 Feedly、Inoreader 等阅读器或其他订阅系统。RSS 条数由后台统一控制。

GET

https://www.uied.cn/api/open/v1/rss.xml

RSS 可直接公开订阅，不需要 API Key；订阅项仅提供已发布内容的标题、原文链接、唯一标识和发布时间。

鉴权

鉴权仅适用于 JSON API。站点设置 Key 后，推荐使用请求头传递，避免密钥进入网页链接和日志；RSS 始终免 Key。

curl 'https://www.uied.cn/api/open/v1/posts?page=1&per_page=20' \
  -H 'X-API-Key: 你的Key'

不要把 API Key 写入前端源码、公开 Git 仓库或可被浏览器查看的环境变量；应由合作方自己的服务端保存并发起请求。

响应字段

JSON 响应结构为 { code, message, data }。其中 data.items 是文章数组，包含以下常用字段：

字段	说明
`id / title / excerpt / url`	文章标识、标题、摘要与原文地址。
`thumbnail`	文章缩略图地址。
`publishedAt / modifiedAt`	发布时间和最后更新时间。
`author`	作者 ID、名称、头像和主页地址。
`category`	文章主分类 ID 与名称。
`stats`	浏览、评论和点赞数量。
`pagination`	当前页、每页条数、总数和总页数。

错误码

错误响应统一为 { code, message, data: null }。合作方应同时判断 HTTP 状态码和响应中的 code。

HTTP	含义与处理方式
`401`	API Key 缺失或无效，检查 `X-API-Key`。
`403`	接口或格式未开启，或请求分类不在开放范围。
`404`	请求的分类别名不存在。
`429`	超过频率限制，读取 `Retry-After` 后重试。
`500`	服务端临时异常，建议指数退避重试并保留请求时间。

安全说明

接口只支持只读 GET，仅返回已发布文章，不提供新增、修改或删除能力。
开放分类由后台白名单控制；未开放分类会返回 403。
每个来源 IP 都受独立限流保护，额度通过 X-RateLimit-* 响应头返回。
JSON API 启用 Key 后使用私有禁缓存策略，接口不会在响应链接中回显 Key。
RSS 免 Key，但仍受开放分类、缓存和来源 IP 限流保护。