Для взаимодействия со службой создания веб-документов используются POST-запросы. Параметры запроса вводятся в формате JSON в теле запроса. Запросы отправляются на адрес https://documentserver/docbuilder, где documentserver — это имя сервера, на котором установлен Сервер документов Р7.

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

Параметр Описание Тип Наличие
Определяет тип запроса к сервису по созданию документов: асинхронный или нет.
Поддерживаемые значения:

  • true
  • false

При использовании асинхронного типа запроса, ответ формируется мгновенно. В этом случае для получения результата необходимо отправлять запросы без изменения параметров до завершения формирования документа. Значение по умолчанию false.

логический необязательно
Определяет идентификатор запроса, используемый для однозначной идентификации запроса. Ключ формируется на стороне сервиса по созданию документов и возвращается в ответ на первый запрос. При использовании асинхронного запроса (для параметра async установлено значение true) ключ отсутствует в первом запросе, но должен присутствовать во всех последующих запросах, которые будут отправлены до завершения формирования. При использовании синхронного запроса (для параметра async установлено значение false) этот параметр необязательный. строковый обязательно
Определяет зашифрованную подпись, добавленную в конфигурацию сервера документов в виде токена. строковый обязательно по конфигурации
Определяет абсолютный URL-адрес файла .docbuilder. строковый обязательно

Файл .docbuilder содержит скрипт, используемый для создания выходного файла документа (текстового документа, электронной таблицы или презентации), определяет формат и имя выходного файла. Когда генерация документа будет готова, будет возвращен ответ с абсолютным URL-адресом результирующего файла (см. ниже).

Пример объекта JSON, отправленного в сервис по созданию документов для первого асинхронного запроса

{
    "async": true,
    "url": "https://example.com/url-to-example-script.docbuilder"
}

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

Формат ответа
{
   "key": "af86C7e71Ca8",
   "end": false
}
{
    "async": true,
    "key": "Khirz6zTPdfd7"
}
Формат ответа
{
   "key": "Khirz6zTPdfd7",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}
{
    "async": false,
    "url": "https://example.com/url-to-example-script.docbuilder"
}

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

Пример ответа

{
   "key": "af86C7e71Ca8",
   "urls": {
      "SampleText.docx": "https://documentserver/SampleText.docx",
      "SampleText2.docx": "https://documentserver/SampleText2.docx"
   },
   "end": true
}
Образец объекта JSON содержит веб-маркер JSON, отправленный в сервис по созданию документов для первого асинхронного запроса.
{
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3luYyI6dHJ1ZSwidXJsIjoiaHR0cHM6Ly9leGFtcGxlLmNvbS91cmwtdG8tZXhhbXBsZS1zY3JpcHQuZG9jYnVpbGRlciJ9.dzoTbRzSMa95Fpg34CjnF3ZUPdGA2CnBedFL_qOOxAs"
}
Пример ответа при возникновении ошибки
{
    "error": -8
}
Возможные коды ошибок и их описание
Код ошибки описание
-1 Неизвестная ошибка.
-2 Ошибка тайм-аута формирования.
-3 Ошибка формирования документа.
-4 Ошибка при загрузке создаваемого файла документа.
-6 Ошибка при доступе к базе данных результатов формирования документов.
-8 Недействительный токен