自动化应用程序编程接口（API）

自动化 API 允许通过自定义界面元素从外部源与办公文档进行交互。利用 ONLYOFFICE 文档处理功能构建您自己的 UI 组件 — 管理评论、控制审阅工作流程、自动填写表单等，所有操作都在编辑器外部完成。

信息

自动化 API 仅适用于 ONLYOFFICE 文档开发者版。

这是一项高级功能，默认不包含，需额外付费。请联系我们的销售团队 sales@onlyoffice.com 获取报价，或访问 onlyoffice.com/automation-api 了解更多信息。

功能展示

探索展示实际用例的交互式示例：

用例	描述
处理评论	在自定义界面中收集和显示所有文档评论。从您自己的 UI 添加、删除和导航评论。
管理审阅修订	从外部控制审阅流程 — 从自定义面板接受或拒绝修订并在修订之间导航。
填写表单	使用外部数据自动填充表单字段。在您的界面和文档之间实时同步表单值。
使用内容控件	添加不同类型的内容控件，并从外部 UI 查看其属性。

快速入门

要开始使用自动化 API，请使用 createConnector 方法创建连接器：

const connector = docEditor.createConnector();

连接器提供执行编辑器命令、监听文档事件和与编辑器 UI 交互的方法：

// 监听文档事件
connector.attachEvent("onChangeContentControl", (obj) => {
  console.log("Content changed:", obj);
});

// 执行编辑器方法
connector.executeMethod("GetAllComments", null, (comments) => {
  console.log("Comments:", comments);
});

// 向文档插入内容
connector.callCommand(() => {
  const oDocument = Api.GetDocument();
  const oParagraph = Api.CreateParagraph();
  oParagraph.AddText("Hello from Automation API");
  oDocument.InsertContent([oParagraph]);
  return {status: "ok"};
}, (res) => {
  console.log("Result:", res);
});

调试

命令日志

要在浏览器控制台中记录所有 callCommand 和 executeMethod 调用，请在浏览器本地存储中设置 asc_plugin_commands_log 键：

localStorage.setItem("asc_plugin_commands_log", "true");

要禁用日志，请删除该键：

localStorage.removeItem("asc_plugin_commands_log");

该设置在页面重新加载后仍然有效。

callCommand 中的错误处理

由于 commandFn 在隔离的上下文中运行，其内部的错误不会传播到调用方。使用 try/catch 块并通过回调返回结果：

connector.callCommand(() => {
  try {
    const doc = Api.GetDocument();
    const stats = doc.GetStatistics();
    return {status: "ok", pages: stats.PageCount};
  } catch (err) {
    return {status: "fail", error: err.stack};
  }
}, (res) => {
  if (res.status !== "ok") {
    console.log(res.error);
  }
});

API 参考

• 连接器类 — 与编辑器交互的方法
• 连接器窗口 — 创建和管理模态窗口的方法