共同编辑

参考图和以下步骤说明了在 ONLYOFFICE 文档服务器中共同编辑文档的过程。

用户 1 和用户 2 在 文档编辑器中打开了一个相同的文档，即打开文件时使用了相同的 document.key。
用户 1 对打开的文档进行更改。
文档编辑器 将用户 1 所做的更改发送到 文档编辑服务。
文档编辑服务 将用户 1 所做的更改发送给用户 2 文档编辑器。
现在这些更改对用户 2 可见。

如何在实践中做到这一点

创建一个空的 html 文件。
添加 div 元素，如下所示。
```
<div id="placeholder"></div>
```
使用将用于您的网站的 JavaScript API来指定您的 ONLYOFFICE 文档服务器链接。
```
<script type="text/javascript" src="https://documentserver/web-apps/apps/api/documents/api.js"></script>
```
其中 documentserver 是安装了 ONLYOFFICE 文档服务器的服务器的名称。

添加脚本指定你想打开的文档，为 div 元素初始化 文档编辑器。 Be sure to add a token when using local links. Otherwise, an error will occur.

new DocsAPI.DocEditor("placeholder", {
    "document": {
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "title": "Example Document Title.docx",
        "url": "https://example.com/url-to-example-document.docx"
    },
    "documentType": "word",
    "editorConfig": {
        "user": {
            "id": "78e1e841",
            "name": "John Smith"
        }
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2N1bWVudCI6eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidGl0bGUiOiJFeGFtcGxlIERvY3VtZW50IFRpdGxlLmRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifSwiZG9jdW1lbnRUeXBlIjoid29yZCIsImVkaXRvckNvbmZpZyI6eyJ1c2VyIjp7ImlkIjoiNzhlMWU4NDEiLCJuYW1lIjoiSm9obiBTbWl0aCJ9fX0.6AcBUCbys9kQ7S982Qm4w1romVg86kZ4ECNsxDff5zU"
});

其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。

在浏览器中打开您的 html 文件。
现在复制上面创建的 html 文件。

在复制的 html 文件中更改初始化 文档编辑器 的脚本。

new DocsAPI.DocEditor("placeholder", {
    "document": {
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "title": "Example Document Title.docx",
        "url": "https://example.com/url-to-example-document.docx"
    },
    "documentType": "word",
    "editorConfig": {
        "user": {
            "id": "F89d8069ba2b",
            "name": "Kate Cage"
        }
    },
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2N1bWVudCI6eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidGl0bGUiOiJFeGFtcGxlIERvY3VtZW50IFRpdGxlLmRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifSwiZG9jdW1lbnRUeXBlIjoid29yZCIsImVkaXRvckNvbmZpZyI6eyJ1c2VyIjp7ImlkIjoiRjg5ZDgwNjliYTJiIiwibmFtZSI6IkthdGUgQ2FnZSJ9fX0.rdmhKLzXwXXVTABioKy3R2-HGMBY5u4pbZ_TVhW2rJs"
});

其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。

在浏览器中打开您复制和编辑的 html 文件。

在共同编辑中使用key

为了打开文档进行编辑，配置初始化需要 key 参数，它允许用户从编辑器缓存中重新打开文档。 key是一个文本字段，它具有有限长度和多个符号。它由软件集成商生成，并定义了唯一的文档标识符，服务用它来识别文档。

key可以使用的字符是：0-9, a-z, A-Z, -._=. key最大长度为128个字符。

因此，用户必须拥有相同的key才能打开文档进行共同编辑。 文档编辑服务 识别试图打开文档的另一个用户（或内联编辑器的另一个标签/编辑会话）的key，如果该key与文件的key匹配，则允许用户打开它。如果key不同，则打开一个与其他文件和文件版本无关的新文件。

一旦发送保存文件的请求（ status 值等于 2）并且操作完成（响应值等于 {"error":0}），则无法使用该key打开文档用于编辑。编辑器加载了一条错误消息。但是，它可以用于从缓存中查看文档（如果存在）。

如果用户在编辑完成之前保存文档（ status 等于 6），则不能更改key。否则，共同编辑将停止。请注意，在强制保存过程之后，对于刚刚进入当前编辑会话的新用户，也无法更改key。

例子

添加脚本,用 key 1初始化文档编辑器。 key未知，打开文件的 URL 已指定。

Be sure to add a token when using local links. Otherwise, an error will occur.

关闭文档编辑器。

new DocsAPI.DocEditor("placeholder", {
    "document": {
        "fileType": "docx",
        "key": "Khirz6zTPdfd7",
        "title": "Example Document.docx",
        "url": "https://example.com/url-to-example-document.docx"
    },
    "documentType": "word",
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkb2N1bWVudCI6eyJmaWxlVHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3IiwidGl0bGUiOiJFeGFtcGxlIERvY3VtZW50LmRvY3giLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifX0.GcpcY8sLCUDqbgqCLvPs6Z0xfBtayOy-GHEXYiZCpfs",
    ...
});