开发人员 ONLYOFFICE 文档 v7.2:API 更新

2022年10月07日作者: Alina

随着版本 7.2 新功能的发布,我们也对编辑器和插件的 API 进行了更新。请在下方查看详细信息。

ONLYOFFICE Docs 7.2 for developers: API updates

实时查看器和全新许可参数

用户可借助实时编辑器在仅查看模式下打开文档、电子表格或演示文稿以实时查看其他协作者所做的变更。了解更多

如需实现此功能,您需要获取包含实时查看器单独字段的全新许可。这些字段分别是 connections_view、users_view_count(连接数和用户数)以及 users_view(用户配额)。可查看许可响应信息以进一步了解。

请注意,实时查看器的服务器连接将与同时连接总数分开计算*。

*可同时在浏览器中打开的、可用于编辑文档的标签页数量。

从外部处理文档

我们提供了全新的 API 类可帮助您从外部同文本文档、电子表格、演示文稿以及可填写表单进行互动。这样您就可创建特殊连接器,用您自己的按钮/方法而不是编辑器的按钮对文件进行修改。例如,您将可在文档中添加注释,回复并关闭注释,或者用从数据库导出的数据自动填写表单。

请注意: 高级API服务包括连接器API类,目前我们只提供高级API服务的演示版(它将随着下一次更新–v7.2.1–被添加到API文件中)。如果您现在想试用它,请联系我们的销售团队:sales@onlyoffice.com

插件 API 增强

插件市场。用户可在全新插件管理器中对所有可用插件进行探索,还可在编辑器中对任何插件进行一键安装或删除。对此我们更新了 API 文件中有关创建和添加插件部分的内容。您也可以阅读这篇文章,了解一下。

更新了本地化方案。现在,您可在文件夹中添加包含翻译的 langs.json 文档。了解更多

新文件中包含特定语言翻译的文件的名称,其会以下列数组形式提供:

[ 
  "cs-CZ",
  "de-DE",
  "es-ES",
  "fr-FR",
  "ru-RU"
]

新增方法: ChangeOleObject, GetAllForms, GetFileToDownload, GetFormsByTag, GetFormValue, GetImageDataFromSelection, GetInstalledPlugins, InstallPlugin, PutImageDataToSelection, RemovePlugin, SetFormValue, ShowButton, UpdatePlugin, 等。

查看插件的完整API变更记录

默认启用JWT

从v7.2开始,JWT被默认启用。ONLYOFFICE 文档安装和启动后,系统会自动生成一个随机的秘密,只需要在主机应用程序的一侧添加。了解更多

其他 API 更新

深色对比主题。可在 editorConfig.customization.uiTheme 参数中启用全新的深色主题变体。其采用了更暗的色调,工作界面几乎是全黑的。

"customization": { ......
   "uiTheme": "theme-contrast-dark",
    }, .......

调整“关于”部分。现在可在编辑器的“关于”部分中添加公司电话号码、徽标、地址以及邮件等信息。只需配置 editorConfig.customization.customer 参数即可。

"editorConfig": {         
    "customization": { ........
         "customer": {
         "address": "My City, 123a-45",
           .....
         "phone": "37188888888"
           },

四字语言代码。定义编辑器界面语言的 editorConfig.lang 参数现已支持四字代码。例如,如需设置葡萄牙语,可在其中声明 pt-pt;声明 pt-br 则可使用巴西葡语。

"editorConfig": {
.....
 "lang": "pt-pt",

中文的选项也有些类似:zh-cn 指简体中文,zh-tw 则是繁体中文。

WOPI 发现新操作。WOPI 发现中的 embedview 操作可渲染一个适合用于在网页中进行嵌入的非编辑文档视图:

<action name="embedview" ext="docx"...

其可通过根据此处说明来对 URL 进行替换以在 SharePoint WOPI 集成中生效,所有独立 WOPI 集成商均需注意这一点。

更新的定价计算器

新增的计算器允许配置更多参数,如多租户和多服务器,高级API访问,实时查看器等。了解更多

立即计算