Для взаимодействия с сервисом конвертации документов используются POST запросы. Параметры запроса указываются в теле запроса в формате JSON. Запросы отправляются по адресу https://documentserver/ConvertService.ashx, где documentserver - имя сервера, на котором установлен Сервер документов.
Параметры и их описание:
Параметр | Описание | Тип | Наличие |
async | Определяет тип запроса на конвертацию: асинхронный или нет. Поддерживаемые значения:
|
логический | необязательный |
codePage | Определяет кодировку файла при конвертации из csv или txt формата. Основные поддерживаемые значения:
|
целочисленный | необязательный |
delimiter | Определяет символ-разделитель для значений, при конвертации из csv формата. Поддерживаемые значения:
|
целочисленный | необязательный |
filetype* | Определяет тип конвертируемого документа. | строка | обязательный |
key | Определяет идентификатор документа, используемый, чтобы однозначно идентифицировать файл документа. | строка | обязательный |
outputtype* | Определяет тип конвертированного документа. | строка | обязательный |
thumbnail | Определяет, что параметр используется. Настройки для, миниатюр при указании форматов изображений (bmp, gif, jpg, png) как outputtype. Объект имеет следующие параметры:
|
объект | необязательный |
title | Определяет имя конвертированного файла. | строка | необязательный |
url | Определяет абсолютную ссылку на документ, который нужно сконвертировать. | строка | обязательный |
* - в таблицах ниже вы можете увидеть возможность конвертации вашего документа в самые распространённые форматы. Колонка Входной формат соответствует значениям параметра filetype, колонка Выходной формат соответствует значениям параметра outputtype.
Форматы файлов текстовых документов
Входной формат | Выходной формат | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
bmp | docx | gif | jpg | odt | pdf/a | png | rtf | txt | ||
doc | + | + | + | + | + | + | + | + | + | + |
docm | + | + | + | + | + | + | + | + | + | + |
docx | + | - | + | + | + | + | + | + | + | + |
dot | + | + | + | + | + | + | + | + | + | + |
dotm | + | + | + | + | + | + | + | + | + | + |
dotx | + | + | + | + | + | + | + | + | + | + |
epub | + | + | + | + | + | + | + | + | + | + |
fodt | + | + | + | + | + | + | + | + | + | + |
html | + | + | + | + | + | + | + | + | + | + |
mht | + | + | + | + | + | + | + | + | + | + |
odt | + | + | + | + | - | + | + | + | + | + |
ott | + | + | + | + | + | + | + | + | + | + |
+ | - | + | + | - | - | + | + | - | - | |
rtf | + | + | + | + | + | + | + | + | - | + |
txt | + | + | + | + | + | + | + | + | + | - |
xps | + | - | + | + | - | + | + | + | - | - |
Форматы файлов таблиц
Входной формат | Выходной формат | ||||||||
---|---|---|---|---|---|---|---|---|---|
bmp | csv | gif | jpg | ods | pdf/a | png | xlsx | ||
csv | + | - | + | + | + | + | + | + | + |
fods | + | + | + | + | + | + | + | + | + |
ods | + | + | + | + | - | + | + | + | + |
ots | + | + | + | + | + | + | + | + | + |
xls | + | + | + | + | + | + | + | + | + |
xlsm | + | + | + | + | + | + | + | + | + |
xlsx | + | + | + | + | + | + | + | + | - |
xlt | + | + | + | + | + | + | + | + | + |
xltm | + | + | + | + | + | + | + | + | + |
xltx | + | + | + | + | + | + | + | + | + |
Форматы файлов презентаций
Входной формат | Выходной формат | |||||||
---|---|---|---|---|---|---|---|---|
bmp | gif | jpg | odp | pdf/a | png | pptx | ||
fodp | + | + | + | + | + | + | + | + |
odp | + | + | + | - | + | + | + | + |
otp | + | + | + | + | + | + | + | + |
pot | + | + | + | + | + | + | + | + |
potm | + | + | + | + | + | + | + | + |
potx | + | + | + | + | + | + | + | + |
pps | + | + | + | + | + | + | + | + |
ppsm | + | + | + | + | + | + | + | + |
ppsx | + | + | + | + | + | + | + | + |
ppt | + | + | + | + | + | + | + | + |
pptm | + | + | + | + | + | + | + | + |
pptx | + | + | + | + | + | + | + | - |
{ "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 }
Код ошибки | Описание |
-1 | Неизвестная ошибка. |
-2 | Ошибка превышения времени ожидания конвертации. |
-3 | Ошибка конвертирования. |
-4 | Ошибка при загрузке конвертируемого документа. |
-6 | Ошибка при доступе к результату конвертации. |
-8 | Неверный токен. |
Комментарии
0 комментариев
Статья закрыта для комментариев.