API конвертации

Для взаимодействия с сервисом конвертации документов используются POST запросы. Параметры запроса указываются в теле запроса в формате JSON. Запросы отправляются по адресу https://documentserver/ConvertService.ashx, где documentserver - имя сервера, на котором установлен Сервер документов.

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

* - в таблицах ниже вы можете увидеть возможность конвертации вашего документа в самые распространённые форматы. Колонка Входной формат соответствует значениям параметра filetype, колонка Выходной формат соответствует значениям параметра outputtype.

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

Форматы файлов таблиц

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

{
    "async": false,
    "filetype": "docx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "pdf",
    "title": "Пример названия документа.docx",
    "url": "https://example.com/url-to-example-document.docx"
}

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

{
    "filetype": "docx",
    "key": "Khirz6zTPdfd7",
    "outputtype": "png",
    "thumbnail": {
        "aspect": 0,
        "first": true,
        "height": 150,
        "width": 100
    },
    "title": "Пример названия документа.docx",
    "url": "https://example.com/url-to-example-document.docx"
}

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

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

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

<?xml version="1.0" encoding="utf-8"?>
<FileResult>
    <EndConvert>True</EndConvert>
    <FileUrl>https://documentserver/ResourceService.ashx?filename=output.doc</FileUrl>
    <Percent>100</Percent>
</FileResult>

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

{
    "endConvert": true,
    "fileUrl": "https://documentserver/ResourceService.ashx?filename=output.doc",
    "percent": 100
}

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

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

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

{
    "error": -3
}