当从 ONLYOFFICE 文档服务器执行 HTTP 请求时,会添加带有 令牌 的授权标头以验证请求。 在向 ONLYOFFICE 文档服务器执行 HTTP 请求时,必须添加带有 令牌 的授权标头以验证请求。
JSON Web 令牌的 有效负载 包含以下字段:
请求接收已编辑文档的状态
使用从 文档存储服务 到 文档命令服务的命令对传入请求执行验证。
{ "payload": { "c": "info", "key": "Khirz6zTPdfd7" } }
POST coauthoring/CommandService.ashx HTTP/1.1 Host: documentserver Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImMiOiJpbmZvIiwia2V5IjoiS2hpcno2elRQZGZkNyJ9fQ.hGQ8kquQWpg4MQYiSYaIzik0wotP1coAop6QfLruenA { "c": "info", "key": "Khirz6zTPdfd7" }
请求转换文档
对从 文档存储服务 到 文档转换服务的传入请求执行验证。
{ "payload": { "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 Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImZpbGV0eXBlIjoiZG9jeCIsImtleSI6IktoaXJ6NnpUUGRmZDciLCJvdXRwdXR0eXBlIjoicGRmIiwidGl0bGUiOiJFeGFtcGxlIERvY3VtZW50IFRpdGxlLmRvY3giLCJ1cmwiOiJodHRwOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQuZG9jeCJ9fQ.Ec50Gvafu4niR2I1LPgETn1jkvvs1wKm0YeeI1RbRQs { "filetype": "docx", "key": "Khirz6zTPdfd7", "outputtype": "pdf", "title": "Example Document Title.docx", "url": "https://example.com/url-to-example-document.docx" }
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
请求文档生成器服务
对从 文档存储服务 到 文档生成服务的传入请求执行验证。
{ "payload": { "async": true, "url": "https://example.com/url-to-example-script.docbuilder" } }
其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息,请参阅 它是如何运作的 部分。
POST docbuilder HTTP/1.1 Host: documentserver Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImFzeW5jIjp0cnVlLCJ1cmwiOiJodHRwczovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLXNjcmlwdC5kb2NidWlsZGVyIn19.JpHp_TB3XDacAhTTB4I0CE7SIESSE9aQUGDulbpYKTE { "async": true, "url": "https://example.com/url-to-example-script.docbuilder" }
其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息,请参阅 它是如何运作的 部分。
当最后一个用户关闭编辑的没有更改的文档时,文档编辑服务向"callbackUrl"地址发送请求
文档编辑服务对发往"callbackUrl"地址的传出请求进行验证。
{ "payload": { "key": "Khirz6zTPdfd7", "status": 4 } }
POST url-to-callback.ashx HTTP/1.1 Host: example.com Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7ImtleSI6IktoaXJ6NnpUUGRmZDciLCJzdGF0dXMiOjR9fQ.MfVoGT-aYuPJfjQAaxwBv7-CqBylDae2AF9K5TpLf-E { "key": "Khirz6zTPdfd7", "status": 4 }
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
请求文件存储服务以进行文件下载
为 文件存储服务 的传出请求执行验证,用于进行文件下载。
{ "payload": { "url": "https://example.com/url-to-example-document.docx" } }
GET url-to-example-document.docx HTTP/1.1 Host: example.com Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7InVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWV4YW1wbGUtZG9jdW1lbnQuZG9jeCJ9fQ.DnhdBVtn8sFo9Adfl6GuT_v53NVV5cQ0Vi9c8xRzrjs
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
令牌包括有效负载(文档的完整 URL,在上面的示例中是 {"url: "http://example.com/url-to-example-document.docx"}),它也在标头作为 主机 (example.com) 和 GET 请求发送到的文档地址 (url-to-example-document.docx)。
请求文件存储服务以进行文件更改数据下载
对 文档存储服务 的传出请求执行验证,用于文档更改数据下载。
{ "payload": { "url": "https://example.com/url-to-document-changes.zip" } }
GET url-to-changes.zip HTTP/1.1 Host: example.com Content-Type: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXlsb2FkIjp7InVybCI6Imh0dHBzOi8vZXhhbXBsZS5jb20vdXJsLXRvLWRvY3VtZW50LWNoYW5nZXMuemlwIn19.4CJ4F8x7VDMW72ss9VnIYGIwjRpBMYBBRXZ5aX2r2Y4
其中 example.com 是安装了 文档管理器 和 文档存储服务 的服务器的名称。 有关文档服务器服务客户端-服务器交互的更多信息,请参阅 它是如何运作的 部分。
令牌包括有效负载(文档的完整 URL,在上面的示例中为 {"url: "http://example.com/url-to-document-changes.zip"),它也在标头作为 主机 (example.com) 和 GET 请求发送到的文档地址 (url-to-document-changes.zip)。