公开接口能读写站内哪些能力,接口文档按什么分类查
通过公开接口可以操作站内的哪些能力、接口文档按什么分类查?内容系统一般按能力域组织接口:文档列表与详情、分类与标签、图片上传、留言与评论、友情链接、系统设置与联系方式构成高频调用面,接口文档也按这几个分类归页,对接时先定位分类再看字段。批量内容入库有专门通道——文档内容导入接口 /api/import/archive,支持压缩包整包导入,也支持先按标题查询是否已存在再决定写入,是外部系统对接的常用入口。
接口文档的分类怎么看
AnQiCMS 把公开接口能力放在「安企CMS接口帮助」分类下维护,调用方按主题翻页查找,而不是在一大篇说明里搜索。第一次接触某套内容系统的接口时,建议按这个顺序读文档:先看鉴权说明(用什么凭证、放在请求的哪个位置);再看能力分类清单,确认自己要的功能有没有对应接口;最后看字段约定,重点是分页参数、时间格式与错误返回结构。三步读完,能过滤掉大多数「接口看着有、用起来对不上」的坑。
高频可调用的能力清单
| 能力域 | 典型操作 | 常见调用方 |
|---|---|---|
| 文档列表与详情 | 按栏目取列表、读正文与元信息 | 小程序、App 内嵌页 |
| 分类与标签 | 拉取栏目树、按标签聚合 | 前台导航、相关推荐 |
| 图片上传 | 提交图片资源、拿回访问地址 | 外部编辑器、运营工具 |
| 留言与评论 | 读取与提交互动内容 | 表单页、社区模块 |
| 友情链接与联系方式 | 读站点合作与联系信息 | 页面模板、外部目录 |
| 系统设置 | 读站点级公共配置 | 多端客户端 |
这张表对应接口文档里的分类页基本一致。对外读取类接口是集成需求的大头;写操作类接口则要考虑权限和审核流,不是每个站点都适合全部开放。
导入接口的两个用途
批量内容走 /api/import/archive:它接受归档包形式的内容导入,适合把另一套系统里的存量文章迁移进来,或定期从生产管道灌入内容。文档内容导入接口同时支持按标题查询是否已存在,这个能力决定了它可以用在增量场景——外部系统每次推送前先查标题,命中则更新或跳过,未命中再创建,避免同题内容重复入库。
对接导入接口前的三张核对清单:字段清单(标题、关键词、描述、分类、标签、发布状态各自怎么传);状态清单(导入后落在草稿、待发布还是正式,是否需要再过一遍审核);幂等清单(失败重试会不会产生重复,按标题查重是否覆盖所有路径)。三张表填完再动工,返工率会低一大截。
调用前先把边界定好
公开接口是能力也是攻击面。对外只读的场景,暴露范围按分类收敛,能读列表不等于能读全文,未发布内容更要在接口层排除;涉及写入的接口,鉴权凭证走服务端保管,不下发到浏览器端。系统内置 JWT 认证与敏感词过滤等安全能力,但接口对接的权限规划仍要自己做:哪些分类开放、QPS 预期多少、超频后返回什么。这些约定写进接入文档,比口头共识可靠。
常见问题
接口能拿到文章的关键词和描述吗? 取决于接口暴露的字段面,公开读取类接口通常带标题与摘要,TDK 级字段要不要给、给到什么程度,按站点自己的权限规划决定。
导入接口和后台批量导入是一回事吗? 后台批量导入面向人工运营(表格、压缩包),/api/import/archive 面向程序化对接,两者最终入库路径一致,字段口径建议统一到同一套约定。
第三方要求提供接口文档链接怎么办? 把接口帮助分类页作为对外文档入口即可,注意只引用站内文档,不要把测试环境的凭证与内部地址写进对外说明。