Для взаимодействия с сервисом конвертации документов используются POST-запросы. Параметры запроса вводятся в формате JSON в теле запроса. Запросы отправляются на адресa:

https://documentserver/ConvertService.ashx

Где documentserver — это имя сервера, на котором установлен Сервер документов Р7.

В Р7 Сервер документов до версии 4.2 использовался GET-запрос с параметрами в QueryString.

Параметры запроса и их описание

Форматы файлов текстовых документов

Форматы файлов электронных таблиц

Форматы файлов презентаций

Образец объекта 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, отправленного в службу конвертации документов, используемого для создания миниатюры файла png в формате docx:

{
    "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 — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе как это работает.
Образец объекта JSON, отправленного в службу конвертации документов, которая используется для преобразования файла электронной таблицы в формат pdf:

{
    "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, отправленный в службу конвертации документов, используемую для преобразования файла из формата docx в формат pdf:

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

Где example.com — это имя сервера, на котором установлены менеджер документов и служба хранения документов. Дополнительные сведения о взаимодействии клиент-сервер службы Сервера документов см. в разделе как это работает.

Параметры ответа и их описание

Результат запроса возвращается в формате XML. Для получения ответа в формате JSON необходимо указать заголовок Accept со значением application/json в HTTP-запросе (доступно с версии 4.3). При формировании ссылки на результирующий файл используется то же имя сервера, на которое был сделан запрос на конвертацию.

Образец ответа в формате XML:

При формировании ссылки на результирующий файл используется то же имя сервера, на которое был сделан запрос на конвертацию:

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

Образец ответа в формате JSON:

При формировании ссылки на результирующий файл используется то же имя сервера, на которое был сделан запрос на конвертацию:

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

Пример промежуточного ответа на асинхронный запрос (с параметром async=true) в формате XML:

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

Пример промежуточного ответа на асинхронный запрос (с параметром async=true) в формате XML:

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

Пример ответа при возникновении ошибки в формате XML:

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

Пример ответа при возникновении ошибки в формате JSON:

{
    "error": -3
}

Возможные коды ошибок и их описание: