概述

从 6.4 版开始，ONLYOFFICE 文档提供 对Web 应用程序开放平台接口协议 (WOPI) 的支持 - 一种基于 REST 的协议， 用于将您的应用程序与online office集成。WOPI 操作允许您打开存储在服务器上的文件、编辑和保存它们。

本文档描述：

• 可以通过 WOPI discovery指定的文件属性；
• 必须构建 主机页面 以在online office内创建 iframe 元素；
• proof keys - 用于检查是否从online office收到请求；
• 支持的 WOPI REST API 函数；
• 可以通过 PostMessage发布的可用消息；
• 在online office中转换不同文件格式请求参数；
• 编辑二进制文档格式的方案；
• ONLYOFFICE 文档 API 和 WOPI 之间的区别。

有关 WOPI 协议的更多信息，请阅读 WOPI 文档。

您可以在配置文件中查找和更改所有必要的WOPI设置，该文件可以在以下路径中找到（或创建）：

启用 WOPI

要启用 WOPI，请将文档服务器配置中的 wopi.enable 参数设置为 true:

名称	描述	类型	示例
wopi.enable	定义是否启用 WOPI。默认值为 false。	boolean	true

{
    "wopi": {
        "enable": true
    }
}

IP过滤器

ONLYOFFICE 文档只能接受来自受信任的集成商的 WOPI 请求。 此类集成商的 IP 地址必须包含在 WOPI 域允许列表中。 同时，必须拒绝所有其他集成商的访问。

默认情况下，所有 IP 地址都被认为是可信的。

按照以下步骤配置文档服务器IP筛选器：

1. 使用任何可用的文本编辑器打开 /etc/onlyoffice/documentserver/local.json 文件：

   "ipfilter": {
       "rules": [
           {
               "address": "ip_address",
               "allowed": true
           },
           {
               "address": "*",
               "allowed": false
           }
       ],
       "useforrequest": false,
       "errorcode": 403
   }
   

2. 更改以下默认设置。输入您的 "ip_address"，其中可以包含：

   • ipv4 的 XXXX 格式的 IP，
   • ipv6 的 xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx 格式的 IP，
   • dns-name,
   • * 通配符替换任何符号。
3. 更改 "允许" 规则,可以为 true 或 false的。

4. 重新启动服务以使配置更改生效：

   对于 RPM/DEB 软件包：

   systemctl restart ds-*
   

   对于 Docker:

   supervisorctl restart all
   

WOPISrc

从8.0版本开始，浏览器向服务器的请求中添加了WOPISrc查询参数。 这允许您创建多个独立的 ONLYOFFICE 实例。 使用 WOPISrc 进行负载平衡请求可确保协作编辑正常工作：编辑同一文档的所有用户都由同一服务器提供服务。

对于WOPI，使用集成器发送的参数。 对于 Docs API，document.key 参数被写入 WOPISrc。