当从 ONLYOFFICE 文档服务器执行 HTTP 请求时, 令牌 被添加到参数中以验证数据。 在向 ONLYOFFICE 文档服务器执行 HTTP 请求时,必须将 令牌 添加到参数中以验证数据。
从版本 5.2 开始,可以在 文档服务器的正文参数中使用令牌。 要启用它,请将配置文件中的 services.CoAuthoring.token.inbox.inBody 和 services.CoAuthoring.token.outbox.inBody 设置为 true。
从版本 7.1 开始,这些参数已被弃用。 现在,传入请求使用正文中的令牌(如果存在)。 否则,将采用标头令牌。 要指定接下来用于验证数据的内容,必须将 services.CoAuthoring.server.tokenRequiredParams 添加到 local.json 配置文件中。 如果为 true,则仅使用令牌数据。否则,打开的请求部分与令牌数据合并。
传出请求同时使用正文中的令牌和标头中的令牌。它们可以不同。 例如,由于标头中令牌的大小限制,可以从标头令牌中删除有关版本历史的信息。
参数 | 描述 | 类型 | 示例 |
services.CoAuthoring.token.inbox.inBody | 指定在 文档命令服务、 文档转换服务 和 文档生成器服务的请求正文中启用令牌验证。 | boolean | false |
services.CoAuthoring.token.outbox.inBody | 指定通过 文档编辑服务 到 文档存储服务为请求正文启用令牌生成。 | boolean | false |
JSON Web 令牌的 有效负载 包含请求正文参数。
请求接收已编辑文档的状态
使用从 文档存储服务 到 文档命令服务的命令对传入请求执行验证。
{ "c": "info", "key": "Khirz6zTPdfd7" }
这些参数必须编码到令牌中,以便请求看起来像这样:
POST coauthoring/CommandService.ashx HTTP/1.1 Host: documentserver Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjIjoiaW5mbyIsImtleSI6IktoaXJ6NnpUUGRmZDcifQ.r_6sThjFABsHMNHhkVdHDSz4jwkbXRQNYdvawkBGJgg" }
如您所见,不需要将上述参数包含在请求正文中,因为它们都已编码到令牌中并在其中发送。
请求转换文档
使用从 文档存储服务 到 文档转换服务的命令对传入请求执行验证。
{ "filetype": "docx", "key": "Khirz6zTPdfd7", "outputtype": "pdf", "title": "Example Document Title.docx", "url": "https://example.com/url-to-example-document.docx" }
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
POST ConvertService.ashx HTTP/1.1 Host: documentserver Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxldHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwib3V0cHV0dHlwZSI6InBkZiIsInRpdGxlIjoiRXhhbXBsZSBEb2N1bWVudCBUaXRsZS5kb2N4IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.U-YAfuuy7clWjn-xOncfJ-sxVG5DlcYn0AOzJYkoR0M" }
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
请求文档生成器服务
使用从 文档存储服务 到 文档生成器服务的命令对传入请求执行验证。
{ "async": true, "url": "https://example.com/url-to-example-script.docbuilder" }
其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息,请参阅 它是如何运作的 部分。
POST docbuilder HTTP/1.1 Host: documentserver Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3luYyI6dHJ1ZSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1zY3JpcHQuZG9jYnVpbGRlciJ9.dzoTbRzSMa95Fpg34CjnF3ZUPdGA2CnBedFL_qOOxAs" }
其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息,请参阅 它是如何运作的 部分。
当最后一个用户关闭编辑的没有更改的文档时,文档编辑服务向"callbackUrl"地址发送请求
文档编辑服务对发往"callbackUrl"地址的传出请求进行验证。
{ "key": "Khirz6zTPdfd7", "status": 4 }
POST url-to-callback.ashx HTTP/1.1 Host: example.com Content-Type: application/json { "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwic3RhdHVzIjo0fQ.gCyNKPpg6ISAnhvFQmRiY6BRqG6WPcEGgnK79hREdkU" }
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
当从 ONLYOFFICE 文档服务器执行 GET 请求时,会添加带有令牌的 授权标头。