Запросить демо
Запросить демо
Документерра: руководство пользователя

[API] Экспорт публикации

Экспорт публикации в указанный формат, при необходимости с загрузкой файла на выбранный FTP-сервер. Ответ выдает ключ задачи, который можно использовать для отслеживания хода выполнения задачи через API.

POST projects/{publication-id}?action=export  

Авторизация

Этот запрос требует базовой авторизации.

Параметры запроса

Параметры пути
publication-id string
Идентификатор экспортируемой публикации.
Параметры поискового запроса
action
string
Действие, которое необходимо выполнить. Поддерживается только экспорт.
Параметры тела запроса
format string

Один из разрешенных форматов экспорта с учетом регистра символов, а именно:

  • WebHelp
  • PureHtml
  • Chm
  • Pdf
  • Doc
  • Docx
  • Rtf
  • Epub
  • Mht
  • Odt
outputFileName string

Полное имя выходного файла. Если выходной файл сохраняется в хранилище файлов Документерры (по умолчанию), должно быть указано полное имя файла, включая путь к файлу, начинающийся с Storage/. Пример:

Storage/export-files/deep-space-1.0-docs.zip

Если файл записывается на FTP-сервер, это должно быть имя файла FTP относительно каталога FTP, в который сохраняется файл. Например:

downloads/deep-space-1.0-docs.zip

exportPresetName


string

Только для печатных форматов. Полное название используемого Пресета экспорта.

ftpInfo
object
[опционально] Объект, определяющий параметры подключения к FTP-серверу. Если указано значение null, выходной файл будет записан в хранилище файлов портала Документерра.
    hostName
string

[опционально] Имя FTP-хоста вашего FTP-сервера, например ftp.hedronlabs.org.

    userName
string
[опционально] Имя пользователя FTP.
    password
string
[опционально] Пароль пользователя FTP.
    isUsePassiveMode
bool
[опционально] Определяет, следует ли использовать пассивный режим для подключения через FTP-соединение. Попробуйте установить значение true (верно), если вы сталкиваетесь с ошибками FTP, в частности с ошибкой 425 «Не удается открыть подключение к данным».
    port
int
[опционально] Порт FTP-сервера, с которым установлено соединение. Если указано значение null или значение не указано, используется порт FTP по умолчанию.

Образцы

Образец запроса
Bash (Unix Shell)
curl --location -g --request POST 'https://{portal-url}/api/v1/projects/space-program-pub?action=export' ^
--header 'Content-Type: application/json' ^
--data-raw '{
"format":"Pdf",
"outputFileName":"Storage/space-program.pdf",
"exportPresetName":"Default",
"ftpInfo":{
"hostName": "ftp.example.com",
"userName": "admin",
"password": "p@ssw0rd",
"isUsePassiveMode": true,
"port": null
}
}'
Образец тела ответа
JSON
{
"taskKey": "85413f07c1644b12add45da9df56ec8b"
}

Поля ответа

taskKey
Ключ задачи процесса экспорта.