转换 API

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

在4.2 版之前的ONLYOFFICE 文档服务器中，使用了带有QueryString参数的 GET 请求。

参数及其说明：

Parameters and their description:

* -在表中可以看到转换的可能性在你的文件转换成最知名的文件格式，其中输入格式列对应的值，文件类型参数和 输出格式列对应的值输出类型参数。

文本文档文件格式

image.png

电子表格文件格式

image.png

演示文稿格式

image.png

发送到文档转换服务的 JSON 对象示例，用于将文件从docx格式转换为pdf格式

{
    "async": false,
    "filetype": "docx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "pdf",
    "title": "Example Document Title.docx",
    "url": "https://example.com/url-to-example-document.docx"
}

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

发送到文档转换服务的 JSON 对象示例，用于将受密码保护的文件从docx格式转换为pdf格式

{
    "async": false,
    "filetype": "docx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "pdf",
    "password": "123456",
    "title": "Example Document Title.docx",
    "url": "https://example.com/url-to-example-document.docx"
}

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

发送到文档转换服务的 JSON 对象示例，用于生成docx格式的文件的png缩略图

{
    "filetype": "docx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "png",
    "thumbnail": {
        "aspect": 0,
        "first": true,
        "height": 150,
        "width": 100
    },
    "title": "Example Document Title.docx",
    "url": "https://example.com/url-to-example-document.docx"
}

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

发送到用于将电子表格文件转换为pdf格式的文档转换服务的 JSON 对象示例

{
    "filetype": "xlsx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "pdf",
    "region": "en-US",
    "spreadsheetLayout": {
        "ignorePrintArea": true,
        "orientation": "portrait",
        "fitToWidth": 0,
        "fitToHeight": 0,
        "scale": 100,
        "headings": false,
        "gridLines": false,
        "pageSize": {
            "width": "210mm",
            "height": "297mm"
        },
        "margins": {
            "left": "17.8mm",
            "right": "17.8mm",
            "top": "19.1mm",
            "bottom": "19.1mm"
        }
    },
    "title": "Example Document Title.docx",
    "url": "https://example.com/url-to-example-spreadsheet.xlsx"
}

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

JSON 对象示例包含发送到文档转换服务的 JSON Web 令牌，用于将文件从docx格式转换为pdf格式

{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmaWxldHlwZSI6ImRvY3giLCJrZXkiOiJLaGlyejZ6VFBkZmQ3Iiwib3V0cHV0dHlwZSI6InBkZiIsInRpdGxlIjoiRXhhbXBsZSBEb2N1bWVudCBUaXRsZS5kb2N4IiwidXJsIjoiaHR0cDovL2V4YW1wbGUuY29tL3VybC10by1leGFtcGxlLWRvY3VtZW50LmRvY3gifQ.U-YAfuuy7clWjn-xOncfJ-sxVG5DlcYn0AOzJYkoR0M"
}

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

请求结果以 XML 格式返回。以接收JSON格式需要在HTTP请求报头指定的响应接受与所述值应用/ JSON（得自4.3版本）。在形成到结果文件的链接时，使用与转换请求相同的服务器名称。

XML 格式的响应示例

在形成到结果文件的链接时，使用与转换请求相同的服务器名称。

<?xml version="1.0" encoding="utf-8"?>
<FileResult>
    <EndConvert>True</EndConvert>
    <FileUrl>https://documentserver/url-to-converted-document.pdf</FileUrl>
    <Percent>100</Percent>
</FileResult>

JSON 格式的响应示例

在形成到结果文件的链接时，使用与转换请求相同的服务器名称。

{
    "endConvert": true,
    "fileUrl": "https://documentserver/url-to-converted-document.pdf",
    "percent": 100
}

XML 格式的异步请求中间响应示例（带有参数async=true）

<?xml version="1.0" encoding="utf-8"?>
<FileResult>
    <EndConvert>False</EndConvert>
    <FileUrl></FileUrl>
    <Percent>95</Percent>
</FileResult>

JSON 格式的对异步请求的中间响应示例（带有参数async=true）

{
    "endConvert": false,
    "percent": 95
}

XML 格式的错误发生时的响应示例

<?xml version="1.0" encoding="utf-8"?>
<FileResult>
    <Error>-3</Error>
</FileResult>

JSON 格式发生错误时的响应示例

{
    "error": -3
}

可能的错误代码及其描述

实际示例：

image.png

image.png