|
2.1.4. Транспортный контейнер Такском
|
|
|
Транспортный контейнер Такском (ТКТ) представляет собой комплект файлов, упакованных в ZIP архив. Присутствие файлов с метаданными в фиксированном формате в ТКТ обязательно. Структура остальных файлов ТКТ может быть произвольной.
ТКТ позволяет отправить одним пакетом три типа данных: метаданные, один или несколько документов (предельный объём - 50 Мб), служебное сообщение, опциональное вложение. Состав ТКТ:
ТКТ должен содержать следующие XML файлы, соответствующие определённым XSD схемам:
|
•
|
Единственный файл meta.xml с информацией о структуре и содержании ТКТ, (подробнее см. п. 2.1.4.1. Файл meta.xml).
|
|
•
|
Файл card.xml для каждого документа данного ТКТ. Этот файл содержит информацию об отправителе и получателе документа, а также может содержать информацию о типе документа, его основных параметрах, дополнительные данные об отправителе и получателе (подробнее см. п. 2.1.4.2. Файл card.xml).
|
Наличие файлов описателя МЧД и/или электронного документа(ов) МЧД и ЭП опционально.
В контейнере может содержаться более одной МЧД с разными способами передачи. (О способах передачи МЧД см. п. 2.1.4.4.)
У одной МЧД, представленной в контейнере в виде файла, может быть только одна подпись.
Если у документа несколько подписей, то одна МЧД может обеспечивать валидность нескольких подписей.
Каждая дополнительная подпись документа может иметь свою отдельную МЧД.
ПРИМЕЧАНИЕ: Имена файлов meta.xml, card.xml и warrant.xml зарезервированы и должны использоваться только в указанных выше целях, нельзя давать такие названия произвольным файлам в составе ТКТ .
Такском-Доклайнз использует ТКТ для пересылки документов и служебных сообщений между интеграционным решением и сервером Такском-Доклайнз. Многие из методов Такском-Доклайнз API принимают или возвращают данные в форме ТКТ. В таблице представлены варианты использования ТКТ:
|
Вариант
|
Содержание ТКТ
|
Входные данные для
|
Выходные данные для
|
|
С единственным электронным документом
|
meta.xml,
card.xml,
документ с ЭП,
опционально - warrant.xml
|
Метод SendMessage (Web API)
Метод Send (.NET SDK)
Метод SendFromFile (COM SDK)
|
Метод GetMainDocumentContainerFromDocflow (.NET SDK)
|
|
С несколькими документами
(пакетом документов)
|
meta.xml
Пакет документов, состоящий из основного и дополнительных документов (см. 5 вариантов состава пакета документов в одном транспортном контейнере)
card.xml и файл ЭП для каждого из документов пакета,
опционально - warrant.xml
|
Метод Send (.NET SDK)
|
-
|
|
Черновик документа
|
meta.xml
card.xml
Черновик документа (без подписи)
|
Метод SendMessage (Web API)
|
Метод GetMessage (Web API)
|
|
Исходящее служебное сообщение
|
meta.xml
card.xml
XML файл служебного сообщения
|
Метод SendMessage (Web API)
|
-
|
|
Документ с частью или полным набором служебных сообщений
|
meta.xml
card.xml
документ с ЭП
XML файл служебного сообщения с ЭП,
опционально - warrant.xml
|
-
|
Метод GetMessage (Web API)
Метод GetDocflowRawData (.NET SDK)
|
|
Статус документооборота
|
meta.xml
|
-
|
Пример ТКТ счёта-фактуры с полным комплектом служебных сообщений на стороне отправителя:
Хотя транспортный контейнер может содержать несколько документов, но он всегда обрабатывается, то есть отклоняется или принимается получателем как один документ. Если несколько документов были отправлены одним контейнером на подписание, то в ответном контейнере должны быть указаны все документы, содержащиеся в исходном контейнере.
Если основной документ не требует переподписи, то все дополнительные тоже должны не требовать переподписи.
Отправка контейнера с несколькими документами тарифицируется как обычная отправка одного документа.
Пример структуры контейнера счёта-фактуры с МЧД:
Файл meta.xml:
Файл warrant.xml:
Подпись подписанта документа, к которой привязана МЧД, указывается в DocSign.
Папка Invoice:
Файл card.xml:
Примечание: Файл card.xml может содержать необязательный параметр WarrantPath, в значении которого передается путь до файла описателя МЧД warrant.xml.