Web 文档生成器 API

对于与 Web 文档生成器服务 的交互，使用 POST 请求。 请求参数在请求正文中以 JSON 格式输入。 请求被发送到 https://documentserver/docbuilder 地址，其中 documentserver 是安装了 ONLYOFFICE 文档服务器的服务器的名称。

参数及其说明：

参数	描述	类型	出现
argument	定义要传递给创建的文档的参数。	object	可选的
async	定义对 文档生成器服务的请求类型：异步与否。 支持的值： true false 使用异步请求类型时，响应立即形成。 在这种情况下，要获得结果，必须在不更改参数的情况下发送请求，直到文档生成完成。 默认值为 false。	boolean	可选的
key	定义用于明确标识请求的请求标识符。 key在 文档生成器服务 端形成，并作为对第一个请求的响应返回。 当使用异步请求时（async 参数设置为 true），key不存在于第一个请求中，但必须存在于将在文档生成完成之前发送的所有后续请求中。 使用同步请求时（ async 参数设置为 false），不需要该参数。	string	必需的
token	以 令牌的形式定义添加到 文档服务器 配置的加密签名。	string	配置要求
url	定义 .docbuilder 文件的绝对 URL。	string	必需的

.docbuilder 文件包含用于生成输出文档文件（文本文档、电子表格或演示文稿）的脚本，指定输出文件格式和名称。 一旦文档生成准备就绪后，将返回带有结果文件绝对 URL 的响应（见下文）。

您可以在 此处 找到有关 .docbuilder 文件语法的更多信息。 请阅读 ONLYOFFICE Document Builder API 文档 ，了解有关使用哪些类和方法在 .docbuilder 文件的帮助下生成文档的详细信息。

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

其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。

{
   "key": "af86C7e71Ca8",
   "end": false
}

{
    "async": true,
    "key": "Khirz6zTPdfd7"
}

{
   "key": "Khirz6zTPdfd7",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}

{
    "async": false,
    "url": "https://example.com/url-to-example-script.docbuilder"
}

其中 example.com 是安装 文档存储服务 的服务器的名称。 有关文档服务器服务客户机-服务器交互的更多信息，请参阅 它是如何运作的 部分。

{
   "key": "af86C7e71Ca8",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3luYyI6dHJ1ZSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1zY3JpcHQuZG9jYnVpbGRlciJ9.dzoTbRzSMa95Fpg34CjnF3ZUPdGA2CnBedFL_qOOxAs"
}

{
    "error": -8
}

{
    "async": false,
    "url": "https://example.com/url-to-example-script.docbuilder",
    "argument": { "key": "string", "key2": "string2" }
}

其中 example.com 是安装文档存储服务的服务器的名称。 请参阅工作原理部分，了解有关文档服务器服务客户端与服务器交互的更多信息。

{
    "key": "af86C7e71Ca8",
    "urls": {
        "SampleText.docx": "https://documentserver/SampleText.docx",
        "SampleText2.docx": "https://documentserver/SampleText2.docx"
    },
    "end": true
}

错误代码	描述
-1	未知错误。
-2	生成超时错误。
-3	文档生成错误。
-4	下载要生成的文档文件时出错。
-6	访问文档生成结果数据库时出错。
-8	令牌无效。