轉(zhuǎn)換 API

對于與文檔轉(zhuǎn)換服務(wù)的交互桅狠，使用 POST 請求劫拢。請求參數(shù)在請求正文中以 JSON 格式輸入褐奥。請求被發(fā)送到https://documentserver/ConvertService.ashx地址仰挣，其中documentserver是安裝了 ONLYOFFICE 文檔服務(wù)器的服務(wù)器的名稱。

在4.2 版之前的ONLYOFFICE 文檔服務(wù)器中伸蚯，使用了帶有QueryString參數(shù)的 GET 請求摩渺。

參數(shù)及其說明：

Parameters and their description:

* -在表中可以看到轉(zhuǎn)換的可能性在你的文件轉(zhuǎn)換成最知名的文件格式臭蚁，其中輸入格式列對應(yīng)的值，文件類型參數(shù)和 輸出格式列對應(yīng)的值輸出類型參數(shù)讯赏。

文本文檔文件格式

image.png

電子表格文件格式

image.png

演示文稿格式

image.png

發(fā)送到文檔轉(zhuǎn)換服務(wù)的 JSON 對象示例垮兑，用于將文件從docx格式轉(zhuǎn)換為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是安裝文檔管理器和文檔存儲服務(wù)的服務(wù)器的名稱。請參閱它的工作原理部分以了解有關(guān)文檔服務(wù)器服務(wù)客戶端-服務(wù)器交互的更多信息待逞。

發(fā)送到文檔轉(zhuǎn)換服務(wù)的 JSON 對象示例甥角，用于將受密碼保護的文件從docx格式轉(zhuǎn)換為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是安裝文檔管理器和文檔存儲服務(wù)的服務(wù)器的名稱。請參閱它的工作原理部分以了解有關(guān)文檔服務(wù)器服務(wù)客戶端-服務(wù)器交互的更多信息识樱。

發(fā)送到文檔轉(zhuǎn)換服務(wù)的 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是安裝文檔管理器和文檔存儲服務(wù)的服務(wù)器的名稱震束。請參閱它的工作原理部分以了解有關(guān)文檔服務(wù)器服務(wù)客戶端-服務(wù)器交互的更多信息怜庸。

發(fā)送到用于將電子表格文件轉(zhuǎn)換為pdf格式的文檔轉(zhuǎn)換服務(wù)的 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是安裝文檔管理器和文檔存儲服務(wù)的服務(wù)器的名稱。請參閱它的工作原理部分以了解有關(guān)文檔服務(wù)器服務(wù)客戶端-服務(wù)器交互的更多信息垢村。

JSON 對象示例包含發(fā)送到文檔轉(zhuǎn)換服務(wù)的 JSON Web 令牌割疾，用于將文件從docx格式轉(zhuǎn)換為pdf格式

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

其中example.com是安裝文檔管理器和文檔存儲服務(wù)的服務(wù)器的名稱。請參閱它的工作原理部分以了解有關(guān)文檔服務(wù)器服務(wù)客戶端-服務(wù)器交互的更多信息嘉栓。

請求結(jié)果以 XML 格式返回宏榕。以接收JSON格式需要在HTTP請求報頭指定的響應(yīng)接受與所述值應(yīng)用/ JSON（得自4.3版本）拓诸。在形成到結(jié)果文件的鏈接時，使用與轉(zhuǎn)換請求相同的服務(wù)器名稱麻昼。

XML 格式的響應(yīng)示例

在形成到結(jié)果文件的鏈接時奠支，使用與轉(zhuǎn)換請求相同的服務(wù)器名稱。

<?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 格式的響應(yīng)示例

在形成到結(jié)果文件的鏈接時抚芦，使用與轉(zhuǎn)換請求相同的服務(wù)器名稱倍谜。

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

XML 格式的異步請求中間響應(yīng)示例（帶有參數(shù)async=true）

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

JSON 格式的對異步請求的中間響應(yīng)示例（帶有參數(shù)async=true）

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

XML 格式的錯誤發(fā)生時的響應(yīng)示例

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

JSON 格式發(fā)生錯誤時的響應(yīng)示例

{
    "error": -3
}

可能的錯誤代碼及其描述

實際示例：

image.png

image.png