SuperAPI AI 工具集

paligo-api

编程与开发

查看项目

更新于 10-15 19:58

技能介绍

用途:为编写与 Paligo CCMS REST API(v2)交互的代码提供参考,覆盖 API 全部资源面。Paligo 以 DocBook 5.x 为基础的 XML 格式存储结构化文档,内容以可复用组件(topics)形式存在。

主要能力:内容(文档、文件夹、fork 分叉)、资源(图片)、检索(搜索)、导入、发布(productions、发布设置、输出)、本地化(翻译导出/导入)、元数据(分类法、变量)以及管理(组、用户、分配)。核心工作流是内容往返:枚举内容、拉取 topic XML、编辑、校验、推送回去。

基础用法:基础地址为 https://{instance}.paligoapp.com/api/v2,{instance} 为客户的 Paligo 实例名。认证使用 HTTP Basic,即 Base64 编码的 username:apikey;API key 在 Paligo 用户设置中按用户生成,账号需具备管理员权限。示例命令:curl -u "user@example.com:API_KEY" "https://example.paligoapp.com/api/v2/documents/123"。请求与响应均为 JSON,时间戳为 Unix 纪元整数。

核心流程:遍历树(GET /folders、GET /documents?parent= 或经 GET /forks?parent= 遍历 publication 结构);拉取(GET /documents/{id},原样保存 content 与 modified_at);预检(checkout 为 true、release_status 为 STATUS_RELEASED 或 STATUS_IN_TRANSLATION 时应拒绝编辑);编辑(在 XML 树上操作,不可增删改 xinfo:* 及 xml:id/id 属性);校验(python3 scripts/validate_paligo_xml.py compare original.xml edited.xml);推送(PUT /documents/{id},body 为 {"content": "<edited xml>"})。首次真实编辑前应做一次无操作往返测试。

限制:PUT 无文档化的服务端 schema 校验;无 ETags/If-Match,只能用 checkout 作建议锁并比对 modified_at;写速率限制较低(文档更新 Business 10/分钟、Enterprise 20/分钟;读取 50/250 每分钟;生产/导入/翻译创建在 Business 为 1/分钟),应对 429 遵守 Retry-After;已发布内容被锁定,需回到 work in progress 生成新版本;发布会自动批准各语言已完成的翻译;编辑段落文本会使该段翻译失效,删除或修改 xinfo:text 会导致既有翻译孤立丢失。该技能与 Paligo 无关联,信息可能过时,应参考官方文档 https://api.paligo.net。