.. _Integration_PrintformsApi_PrintformsApiConcept:

Как работать с Printforms API
#############################

Печатная форма (ПФ) - это человеко-читаемое представление документа.

Для формализованных и части полуформализованных документов ПФ необходимы, потому что содержимое документа - это структурированные данные в XML, JSON и т. п.
Для прочих документов ПФ может использоваться для визуализации данных электронных подписей.

В большинстве случаев ПФ генерируются операторами ЭДО и представляют собой PDF-файл.
Однако существуют сценарии использования Продукта, при которых использовать ПФ операторов невозможно или неудобно:

* Если нужен предпросмотр документа перед отправкой контрагенту через оператора. В этом случае ПФ оператора еще не существует.
* Если нужно унифицировать внешний вид ПФ. Основной вариант использования Продукта - подключение к нескольким операторам, а внешний вид ПФ у разных операторов различается.
* Если нужно контролировать производительность системы в части генерации ПФ. Генерация ПФ - достаточно тяжелая операция.
  Не все сервисы операторов справляются с нагрузкой так, чтобы ПФ могла поступать в приемлемые сроки.
* Если нужна ПФ в HTML-формате.
* Если нужна нестандартная ПФ. Стороны могут обмениваться структурированными документами, для которых сервис оператора может не уметь генерировать ПФ.
  Либо может использоваться внутренний документооборот со своими форматами документов.

В этих случаях нужно использовать Printforms API.

Порядок генерации печатной формы
********************************

| Печатная форма генерируется асинхронно.
| Для генерации ПФ нужно:

* поставить задачу на печать документа;
* дождаться генерации ПФ и загрузить результат.

Поддерживаемые типы документов
******************************

По умолчанию поддерживается генерация ПФ для формализованных документов и документов в формате Word (``docx``, ``doc``), Excel (``xlsx``, ``xls``), PDF.

На проектной основе возможна реализация различных нестандартных ПФ.
Подробную информацию о реализации нестандартных ПФ на проектной основе следует запрашивать в проектной поддержке Продукта.