跳到主要内容

请求体中的令牌

从 5.2 版本开始，可以在 ONLYOFFICE 文档的请求体参数中使用令牌。要启用它，请将配置文件中的 services.CoAuthoring.token.inbox.inBody 和 services.CoAuthoring.token.outbox.inBody 设置为 true。

参数​

参数类型示例描述
services.CoAuthoring.token.inbox.inBodybooleanfalse定义是否在传入请求体中启用令牌。
services.CoAuthoring.token.outbox.inBodybooleanfalse定义是否在传出请求体中启用令牌。

JSON Web 令牌的 payload 包含请求正文参数。

信息

在以下示例中，example.com 代表安装文档存储服务的服务器。请参阅工作原理章节了解更多关于 ONLYOFFICE 文档服务客户端-服务器交互的信息。

传入请求​

获取文档状态​

使用从文档存储服务到文档命令服务的命令对传入请求执行验证。

示例参数：

{
  "c": "info",
  "key": "Khirz6zTPdfd7"
}

这些参数必须编码到令牌中，以便请求看起来像这样：

Request:

curl -X POST "https://documentserver/command" \
  -H "Content-Type: application/json" \
  -d '{
    "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"
}

Request:

curl -X POST "https://documentserver/converter" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxldHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwib3V0cHV0dHlwZSI6InBkZiIsInRpdGxlIjoiRXhhbXBsZSBEb2N1bWVudCBUaXRsZS5kb2N4IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.U-YAfuuy7clWjn-xOncfJ-sxVG5DlcYn0AOzJYkoR0M"
  }'

文档生成器​

使用从文档存储服务到文档生成器服务的命令对传入请求执行验证。

示例参数：

{
  "async": true,
  "url": "https://example.com/url-to-example-script.js"
}

Request:

curl -X POST "https://documentserver/docbuilder" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3luYyI6dHJ1ZSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1zY3JpcHQuanMifQ.jQ9VN6BUntLel-sKN5CGvWPnq3hDU1WJIA18LaQqs_I"
  }'

传出请求​

关闭时回调（无更改）​

文档编辑服务对 "callbackUrl" 地址的传出请求执行验证。

示例参数：

{
  "key": "Khirz6zTPdfd7",
  "status": 4
}

Request:

curl -X POST "https://example.com/url-to-callback.ashx" \
  -H "Content-Type: application/json" \
  -d '{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwic3RhdHVzIjo0fQ.gCyNKPpg6ISAnhvFQmRiY6BRqG6WPcEGgnK79hREdkU"
  }'

当从 ONLYOFFICE 文档执行 GET 请求时，会添加带有令牌的授权头。