Nitro Sign Enterprise Verified (предварительная версия)

Nitro Sign Enterprise Verified — это известное решение цифровой подписи, предлагающее огромное количество методов подписи и соответствия самым строгим (межнационным нормативным требованиям). NSEV позволяет преобразовать любой бумажный процесс в сквозной цифровой поток с непарабельным взаимодействием с пользователем. Оптимизируйте процесс подписывания точно так, как вы хотите его отправлять и отправлять, подписывать и отслеживать все типы документов непосредственно из любимых бизнес-приложений.

Этот соединитель доступен в следующих продуктах и регионах:

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Поддержка nitro
URL	https://www.gonitro.com/support
Адрес электронной почты	service@gonitro.com

Метаданные соединителя
Publisher	Nitro Software Бельгия NV
Website	https://www.gonitro.com
Политика конфиденциальности	https://www.gonitro.com/legal/privacy-policy
Категории	ИТ-операции; Продуктивность

Проверенный соединитель Nitro Sign Enterprise

Nitro Software, специалист в Smart Document Solutions, сделал Nitro Sign Enterprise Проверенный соединитель для Power Automate доступным для использования. Соединитель позволяет компаниям пересылать документы, требующие цифровой подписи непосредственно из любимых приложений Microsoft 365 — от Microsoft Teams до Word, SharePoint, Dynamics, OneDrive и многих других. Nitro Sign Enterprise Verified - ранее известный как Nitro Sign Premium и Connective eSignatures.

Предпосылки

Чтобы начать использовать соединитель, требуется существующая подписка на Nitro Sign Enterprise Verified. Обратитесь к вашему контакту в Nitro Software или перейдите на нашу страницу справки и поддержки на нашем веб-сайте, чтобы получить учетные данные.

Documentation

На этой странице будут подробно описаны различные доступные действия, а также сведения о различных способах реализации этих действий.

Не стесняйтесь смотреть на наш веб-сайт документации для получения дополнительной информации или обратиться к группе поддержки через нашу страницу справки и поддержки или почтовый ящик поддержки: mailto:service@gonitro.com. Документация по API также доступна в формате Postman.

Глоссарий доступен для объяснения различных терминов, используемых в этой документации.

Поддерживаемые операции

Соединитель Nitro Sign Enterprise Verified основан на API версии 4 проверки nitro Sign Enterprise. API — это REST API, который позволяет внешним приложениям интегрироваться и использовать функции, перечисленные в этом документе, для создания потоков подписывания и управления ими.

Доступные действия можно сгруппировать в разные группы

Группа действий	Доступные действия
Packages	Получение всех пакетов
	Получение пакета по идентификатору
	Получение состояния пакета
	Создание нового пакета (стандартный или мгновенный экземпляр)
	Удаление пакета по идентификатору
	Обновление состояния пакета
	Получение даты окончания срока действия пакета
	Обновление даты окончания срока действия пакета
	Пропускающие подписи
	Отправка напоминаний
	Скачивание пакета
	Скачивание следа аудита пакета
Documents	Добавление документа в пакет
	Скачивание подписанного документа из пакета
Заинтересованные лица	Удаление заинтересованных лиц по идентификатору
	Получение всех заинтересованных лиц пакета
	Добавление заинтересованных лиц в пакет
Процедура	Получение всех шагов процесса пакета
Процедура	Добавление шага в процесс пакета
Процедура	Перезапись шагов процесса пакета
Процедура	Получение всех действий шага процесса
Процедура	Удаление шага процесса и всех его субъектов
Процедура	Добавление субъекта в шаг процесса
Процедура	Получение всех действий на текущем этапе процесса
Other	Получение всех языков, включенных в приложении
	Получение всех тем, которые можно назначить пакету
	Получение всех групп документов, которым может быть назначен пакет
	Получение всех настроенных методов подписывания

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:


По умолчанию	Параметры для создания подключения.	Все регионы	Недоступен для совместного использования

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Имя	Тип	Description	Обязательно
Узел подписи Nitro	струна	узел и путь к среде знака Nitro, например contoso.sign.gonitro.com/esig	True
Имя пользователя API	securestring	Имя пользователя API для доступа к API	True
Пароль API	securestring	Пароль API для доступа к API	True

Ограничения регулирования

Имя	Вызовы	Период обновления
Вызовы API для каждого подключения	100	60 секунд

Действия

Возвращает все методы подписывания, настроенные в настоящее время	Возвращает все методы подписывания, настроенные в настоящее время
Добавление документа в пакет	Добавляет документ в существующий пакет.
Добавление заинтересованных лиц в пакет	Добавляет заинтересованных лиц в пакет
Добавление субъекта в шаг процесса	Добавляет субъект к шагу процесса.
Добавление шага в процесс пакета	Добавляет набор действий в процесс пакета.
Обновление даты окончания срока действия пакета	Обновление даты окончания срока действия пакета
Обновление состояния пакета	Обновляет состояние пакета.
Отправка напоминаний о пакете	Политика компании может потребовать, чтобы документ обрабатывался в пределах заданного интервала времени. Активация вызова "отправки напоминаний" будет искать всех, кто не подписал, и отправить им дополнительное уведомление в качестве напоминания.
Перезапись шагов процесса пакета	Перезаписывает все субъекты в пакете с помощью массива 2D, где каждый набор субъектов — это действия, которые могут выполняться параллельно.
Получение всех групп документов, которым можно назначать пакеты	Извлекает все группы документов, которым могут быть назначены пакеты
Получение всех действий на текущем этапе процесса	Возвращает текущий набор действий, которые можно выполнить параллельно.
Получение всех действий шага процесса	Возвращает определенный набор действий, которые могут выполняться параллельно из процесса.
Получение всех заинтересованных лиц пакета	Извлекает заинтересованных лиц пакета
Получение всех пакетов	Возвращает все пакеты, они отсортированы по созданиюDate
Получение всех тем, которые можно назначить пакету	Извлекает все темы, которые могут быть назначены пакету. Возможные страницы результатов путем предоставления MaxQuantity и продолженияToken
Получение всех шагов процесса	Возвращает все действия, которые должны выполняться в пакете.
Получение всех языков, включенных в приложение	Извлекает все языки, включенные в приложение
Получение даты окончания срока действия пакета	Получение даты окончания срока действия пакета
Получение пакета по идентификатору	Извлекает пакет по идентификатору.
Получение состояния пакета	Извлекает текущее состояние пакета.
Пропускающие подписи	Этот вызов пропускает все подписи, которые еще не завершены, и задает их состояние "Пропущено", что приводит к тому, что полный пакет помечается как "Готово".
Скачивание документа из пакета	Скачайте подписанный документ из пакета. Каждый документ будет скачан в формате PDF или XML-файла.
Скачивание пакета	Используется для скачивания всех документов в определенном пакете в виде ZIP-файла.
Скачивание тропы аудита пакета	Скачайте подписанный путь аудита о времени существования пакета.
Создание нового пакета (стандартный или мгновенный)	Создает новый пакет. По умолчанию пакет создается в виде черновика. Чтобы создать мгновенный пакет, который немедленно готов к подписи, задайте `status` для свойства значение `Pending`. Заметка: Конечная `POST /packages` точка позволяет создавать стандартные и мгновенные пакеты.
Удаление заинтересованных лиц по идентификатору	Удаляет заинтересованных лиц по его идентификатору.
Удаление пакета по идентификатору	Удаляет пакет по идентификатору.
Удаление шага процесса и всех его субъектов	Удаляет шаг процесса и все его субъекты.

Возвращает все методы подписывания, настроенные в настоящее время

Идентификатор операции:: GetAllSigningMethods

Возвращает все методы подписывания, настроенные в настоящее время

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Возвращает только активные и неактивные методы подписывания	isActive		boolean	Возвращает только активные и неактивные методы подписывания

Возвращаемое значение

response: array of ConfiguredSigningMethod

Добавление документа в пакет

Идентификатор операции:: Documents_AddToPackage

Добавляет документ в существующий пакет.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Имя	Name	True	string	Имя документа
IsOptional	IsOptional		boolean	Указывает, должен ли документ быть необязательным для подписи
Language	Language	True	string	2-буквенный ISO-код страны (ISO 639-1)
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
ProofCorrelationId	ProofCorrelationId		string	Глобальный уникальный идентификатор
Тип Цели	TargetType		string	Будет работать только в том случае, если сервер настроен для преобразования документов.
TargetFormat	TargetFormat		string	Целевой формат определяет, необходимо ли выполнить дополнительное преобразование.
PdfErrorHandling	PdfErrorHandling		string	Как справиться с PDF-файлами, содержащими незначительные недостатки
ContentType	ContentType	True	string	Тип MIME документа
Base64Data	Base64Data	True	byte	Содержимое документа в кодировке Base64
Тип	Type	True	string	Тип элемента
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Language	Language		string	2-буквенный ISO-код страны (ISO 639-1)

Возвращаемое значение

Тело: Response.Document

Добавление заинтересованных лиц в пакет

Идентификатор операции:: Packages_AddStakeholder

Добавляет заинтересованных лиц в пакет

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Тип	Type	True	string	Тип заинтересованных лиц
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Language	Language	True	string	2-буквенный ISO-код страны (ISO 639-1)
Имя	FirstName		string	Имя заинтересованных лиц
Фамилия	LastName	True	string	Фамилия заинтересованных лиц
Электронный адрес	EmailAddress	True	email	Адрес электронной почты
BirthDate	BirthDate		date
Номер телефона	PhoneNumber		string	Номер телефона
AdditionalProperties	AdditionalProperties		object	Настраиваемые дополнительные свойства заинтересованных лиц
Тип	Type	True	string	Тип действия, которое необходимо выполнить в пакете
ПодавлениеNotifications	SuppressNotifications		boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl		url	URL-адрес перенаправления после завершения действия субъекта
Тип редиректа	RedirectType		string
BackButtonUrl	BackButtonUrl		url	URL-адрес, в который пользователь отправляется после закрытия сеанса
Идентификатор	Id		string	Идентификатор существующего элемента. Если используется, все остальные поля должны быть пустыми.
Тип	Type		string	Тип элемента
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
DocumentId	DocumentId		string	Идентификатор документа в пакете
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Language	Language		string	2-буквенный ISO-код страны (ISO 639-1)

Возвращаемое значение

Тело: Response.Stakeholder

Добавление субъекта в шаг процесса

Идентификатор операции:: Process_StepPost

Добавляет субъект к шагу процесса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Индекс шага процесса	stepIndex	True	integer	Индекс шага процесса
Тип	Type	True	string	Тип действия, которое необходимо выполнить в пакете
Заинтересованные лица	StakeholderId	True	string	Идентификатор заинтересованных лиц в пакете
ПодавлениеNotifications	SuppressNotifications		boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl		url	URL-адрес перенаправления после завершения действия субъекта
Идентификатор	Id		string	Идентификатор существующего элемента. Если используется, все остальные поля должны быть пустыми.
Тип	Type		string	Тип элемента
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
DocumentId	DocumentId		string	Идентификатор документа в пакете
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Language	Language		string	2-буквенный ISO-код страны (ISO 639-1)

Возвращаемое значение

Тело: Response.Actor

Добавление шага в процесс пакета

Идентификатор операции:: Process_PostStep

Добавляет набор действий в процесс пакета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Тип	Type	True	string	Тип действия, которое необходимо выполнить в пакете
Заинтересованные лица	StakeholderId	True	string	Идентификатор заинтересованных лиц в пакете
ПодавлениеNotifications	SuppressNotifications		boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl		url	URL-адрес перенаправления после завершения действия субъекта
Идентификатор	Id		string	Идентификатор существующего элемента. Если используется, все остальные поля должны быть пустыми.
Тип	Type		string	Тип элемента
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
DocumentId	DocumentId		string	Идентификатор документа в пакете
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Language	Language		string	2-буквенный ISO-код страны (ISO 639-1)

Возвращаемое значение

Набор субъектов в шаге процесса.

response: array of Response.Actor

Обновление даты окончания срока действия пакета

Идентификатор операции:: Packages_PutExpiryDate

Обновление даты окончания срока действия пакета

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
ExpiryTimestamp	ExpiryTimestamp		date-time	Значение даты и времени в формате ISO 8601

Обновление состояния пакета

Идентификатор операции:: Packages_UpdateStatus

Обновляет состояние пакета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
body	body	True	string

Отправка напоминаний о пакете

Идентификатор операции:: Packages_SendReminders

Политика компании может потребовать, чтобы документ обрабатывался в пределах заданного интервала времени. Активация вызова "отправки напоминаний" будет искать всех, кто не подписал, и отправить им дополнительное уведомление в качестве напоминания.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Перезапись шагов процесса пакета

Идентификатор операции:: Process_Put

Перезаписывает все субъекты в пакете с помощью массива 2D, где каждый набор субъектов — это действия, которые могут выполняться параллельно.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Тип	Type	True	string	Тип действия, которое необходимо выполнить в пакете
Заинтересованные лица	StakeholderId	True	string	Идентификатор заинтересованных лиц в пакете
ПодавлениеNotifications	SuppressNotifications		boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl		url	URL-адрес перенаправления после завершения действия субъекта
Идентификатор	Id		string	Идентификатор существующего элемента. Если используется, все остальные поля должны быть пустыми.
Тип	Type		string	Тип элемента
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
DocumentId	DocumentId		string	Идентификатор документа в пакете
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Language	Language		string	2-буквенный ISO-код страны (ISO 639-1)

Получение всех групп документов, которым можно назначать пакеты

Идентификатор операции:: GetDocumentGroups

Извлекает все группы документов, которым могут быть назначены пакеты

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя группы документов (или часть) для поиска	name		string	Имя группы документов (или часть) для поиска

Возвращаемое значение

Имя	Путь	Тип	Описание
DocumentGroups	DocumentGroups	array of object	Список групп документов
Code	DocumentGroups.Code	string	Код группы документов
Имя	DocumentGroups.Name	string	Имя группы документов

Получение всех действий на текущем этапе процесса

Идентификатор операции:: Process_GetCurrentStep

Возвращает текущий набор действий, которые можно выполнить параллельно.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

Имя	Путь	Тип	Описание
Товары	Items	array of Response.Actor

Получение всех действий шага процесса

Идентификатор операции:: Process_GetStep

Возвращает определенный набор действий, которые могут выполняться параллельно из процесса.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Индекс шага процесса	stepIndex	True	integer	Индекс шага процесса

Возвращаемое значение

Имя	Путь	Тип	Описание
Товары	Items	array of Response.Actor

Получение всех заинтересованных лиц пакета

Идентификатор операции:: Packages_GetStakeholders

Извлекает заинтересованных лиц пакета

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

response: array of Response.Stakeholder

Получение всех пакетов

Идентификатор операции:: Packages_Get

Возвращает все пакеты, они отсортированы по созданиюDate

Параметры

Имя	Ключ	Тип	Описание
Номер страницы для получения	pageNumber	integer	Номер страницы для получения
Количество элементов на странице	pageSize	integer	Количество элементов на странице
Возврат пакетов, созданных до этой даты	createdBefore	date-time	Возврат пакетов, созданных до этой даты
Возврат пакетов, созданных после этой даты	createdAfter	date-time	Возврат пакетов, созданных после этой даты
Состояние пакетов для фильтрации	status	string	Состояние пакетов для фильтрации
Код группы документов для фильтрации пакетов	documentGroupCode	string	Код группы документов для фильтрации пакетов
Электронная почта инициатора пакета для фильтрации	initiator	email	Электронная почта инициатора пакета для фильтрации
Имя пакета для фильтрации	packageName	string	Имя пакета для фильтрации
Внешняя ссылка на пакеты фильтрации	externalReference	string	Внешняя ссылка на пакеты фильтрации
Укажите способ сортировки результата, по умолчанию убывание	sort	string	Укажите способ сортировки результата, по умолчанию убывание

Возвращаемое значение

Имя	Путь	Тип	Описание
PageNumber	PageNumber	integer	Текущий номер страницы
PageSize	PageSize	integer	Количество элементов на странице
TotalPages	TotalPages	integer	Общее количество страниц
TotalItems	TotalItems	integer	Общее количество элементов
Товары	Items	array of Response.Package.Get

Получение всех тем, которые можно назначить пакету

Идентификатор операции:: GetAllThemes

Извлекает все темы, которые могут быть назначены пакету. Возможные страницы результатов путем предоставления MaxQuantity и продолженияToken

Параметры

Имя	Ключ	Тип	Описание
Маркер для получения следующего набора результатов	continuationToken	string	Маркер для получения следующего набора результатов
Максимальное количество возвращаемых результатов	maxQuantity	integer	Максимальное количество возвращаемых результатов
Порядок сортировки результатов	sortOrder	string	Порядок сортировки результатов
укажите, в каком поле для сортировки	sortField	string	укажите, в каком поле для сортировки

Возвращаемое значение

Имя	Путь	Тип	Описание
Токен продолжения	ContinuationToken	string	Маркер для получения следующей страницы результатов
Товары	Items	array of object	Список, содержащий темы
Code	Items.Code	string	Код темы
Имя	Items.Name	string	Имя темы
MaxQuantity	MaxQuantity	integer	Максимальное количество результатов, возвращаемых для каждого запроса
Total	Total	integer	Общее количество результатов.

Получение всех шагов процесса

Идентификатор операции:: Process_Get

Возвращает все действия, которые должны выполняться в пакете.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

Имя	Путь	Тип	Описание
		array of array
items		array of Response.Actor	Набор субъектов в шаге процесса.

Получение всех языков, включенных в приложение

Идентификатор операции:: GetAllEnabledLanguages

Извлекает все языки, включенные в приложение

Возвращаемое значение

Имя	Путь	Тип	Описание
EnabledLanguages	EnabledLanguages	array of object	Список языков с поддержкой
Отображаемое имя	EnabledLanguages.DisplayName	string	Отображаемое имя языка
NativeName	EnabledLanguages.NativeName	string	Собственное имя языка
IsoCultureCode	EnabledLanguages.IsoCultureCode	string	2 буквы ISO-кода (ISO 639-1) языка

Получение даты окончания срока действия пакета

Идентификатор операции:: Packages_GetExpiryDate

Получение даты окончания срока действия пакета

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

Значение даты и времени в формате ISO 8601

response: Common.DateTime

Получение пакета по идентификатору

Идентификатор операции:: Packages_GetPackage

Извлекает пакет по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

Тело: Response.Package.Get

Получение состояния пакета

Идентификатор операции:: Packages_GetStatus

Извлекает текущее состояние пакета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

Тело: Response.Package.Status

Пропускающие подписи

Идентификатор операции:: Packages_SkipSigners

Этот вызов пропускает все подписи, которые еще не завершены, и задает их состояние "Пропущено", что приводит к тому, что полный пакет помечается как "Готово".

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Скачивание документа из пакета

Идентификатор операции:: Documents_DownloadDocumentFromPackage

Скачайте подписанный документ из пакета. Каждый документ будет скачан в формате PDF или XML-файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Уникальный идентификатор документа, содержащегося в пакете	documentId	True	string	Уникальный идентификатор документа, содержащегося в пакете

Возвращаемое значение

response: binary

Скачивание пакета

Идентификатор операции:: Packages_DownloadPackage

Используется для скачивания всех документов в определенном пакете в виде ZIP-файла.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Возвращаемое значение

response: binary

Скачивание тропы аудита пакета

Идентификатор операции:: Packages_DownloadAuditTrail

Скачайте подписанный путь аудита о времени существования пакета.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Код ISO на языке 2 (ISO 639-1)	culture	True	string	Код ISO на языке 2 (ISO 639-1)

Возвращаемое значение

response: binary

Создание нового пакета (стандартный или мгновенный)

Идентификатор операции:: Packages_CreatePackage

Создает новый пакет. По умолчанию пакет создается в виде черновика. Чтобы создать мгновенный пакет, который немедленно готов к подписи, задайте status для свойства значение Pending.

Заметка: Конечная POST /packages точка позволяет создавать стандартные и мгновенные пакеты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя	Name	True	string	Имя пакета
Initiator	Initiator	True	email	Адрес электронной почты
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Состояние	Status		string	Состояние созданного пакета. Используется `"Draft"` для создания стандартного пакета, который можно изменить перед отправкой. Используется `"Pending"` для создания мгновенного пакета, который сразу же готов к подписанию.
DocumentGroupCode	DocumentGroupCode		string	Код группы документов для пакета
Срок действия	ExpiryDate		date-time	Значение даты и времени в формате ISO 8601
Имя	Name	True	string	Имя документа
IsOptional	IsOptional		boolean	Указывает, должен ли документ быть необязательным для подписи
Language	Language	True	string	2-буквенный ISO-код страны (ISO 639-1)
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
ProofCorrelationId	ProofCorrelationId		string	Глобальный уникальный идентификатор
Тип Цели	TargetType		string	Будет работать только в том случае, если сервер настроен для преобразования документов.
TargetFormat	TargetFormat		string	Целевой формат определяет, необходимо ли выполнить дополнительное преобразование.
PdfErrorHandling	PdfErrorHandling		string	Как справиться с PDF-файлами, содержащими незначительные недостатки
ContentType	ContentType	True	string	Тип MIME документа
Base64Data	Base64Data	True	byte	Содержимое документа в кодировке Base64
Тип	Type	True	string	Тип элемента
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
ПодписываниеMethods	SigningMethods		array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
Тип	Type	True	string	Тип заинтересованных лиц
ExternalReference	ExternalReference		string	Внешняя ссылка для пакета
Language	Language	True	string	2-буквенный ISO-код страны (ISO 639-1)
Имя	FirstName		string	Имя заинтересованных лиц
Фамилия	LastName	True	string	Фамилия заинтересованных лиц
Электронный адрес	EmailAddress	True	email	Адрес электронной почты
BirthDate	BirthDate		date
Номер телефона	PhoneNumber		string	Номер телефона
AdditionalProperties	AdditionalProperties		object	Настраиваемые дополнительные свойства заинтересованных лиц
Тип	Type	True	string	Тип действия, которое необходимо выполнить в пакете
ПодавлениеNotifications	SuppressNotifications		boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl		url	URL-адрес перенаправления после завершения действия субъекта
Тип редиректа	RedirectType		string
BackButtonUrl	BackButtonUrl		url	URL-адрес, в который пользователь отправляется после закрытия сеанса
ProcessStep	ProcessStep		integer	Номер шага процесса
DocumentIndex	DocumentIndex	True	integer	Индекс документа в пакете (начиная с 0) — доступен только в конечной точке создания пакета.
Тип	Type	True	string	Тип элемента
Страница	Page		integer	Номер страницы документа
Верх	Top		number	Верхняя позиция в пикселях
Лево	Left		number	Положение слева в пикселях
Ширина	Width		number	Ширина элемента
Высота	Height		number	Высота элемента
ПодписываниеMethods	SigningMethods	True	array of string
Имя	Name		string	Имя юридического уведомления, добавляемого в поле подписывания.
Content	Content		string	Содержимое пользовательского юридического уведомления.
ThemeCode	ThemeCode		string	Идентификатор темы для пакета
CallBackUrl	CallBackUrl		url	URL-адрес обратного вызова после выполнения действий
NotificationCallBackUrl	NotificationCallBackUrl		url	URL-адрес обратного вызова, когда подписыватель запрашивает новый URL-адрес подписи
DefaultRedirectUrl	DefaultRedirectUrl		url	URL-адрес перенаправления после завершения действия
F2fRedirectUrl	F2fRedirectUrl		url	URL-адрес перенаправления после подписи лиц
IsUnsignedContentDownloadable	IsUnsignedContentDownloadable		boolean	Можно ли скачать неподписанный контент
IsReassignEnabled	IsReassignEnabled		boolean	Включена ли переназначение

Возвращаемое значение

Тело: Response.Package.Get

Удаление заинтересованных лиц по идентификатору

Идентификатор операции:: Stakeholder_DeleteById

Удаляет заинтересованных лиц по его идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Уникальный идентификатор заинтересованных лиц	stakeholderId	True	string	Уникальный идентификатор заинтересованных лиц

Удаление пакета по идентификатору

Идентификатор операции:: Packages_DeleteById

Удаляет пакет по идентификатору.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета

Удаление шага процесса и всех его субъектов

Идентификатор операции:: Process_DeleteStep

Удаляет шаг процесса и все его субъекты.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Уникальный идентификатор пакета	packageId	True	string	Уникальный идентификатор пакета
Индекс шага процесса	stepIndex	True	integer	Индекс шага процесса

Определения

ConfiguredSigningMethod

Настроенный метод подписи в eSignatures

Имя	Путь	Тип	Описание
Активен	IsActive	boolean	Можно ли использовать подписываниеMethod для создания новых полей подписывания
Имя	Name	string	Настроено имя метода подписывания
DisplayNames	DisplayNames	object	Имя для каждого языка, которое будет отображаться в подписыватель
DisplayNamesInitiator	DisplayNamesInitiator	object	Имя каждого языка, которое должно отображаться инициатору при создании пакета.
Описания	Descriptions	object	Описание метода подписывания на языке для предоставления дополнительных сведений о методе подписывания во время создания пакета.
RequiredProperties	RequiredProperties	array of string	Обязательные свойства для обязательного подписывания
KeyPairs	KeyPairs	array of KeyPair	доступные keyPairs, которые можно использовать для входа с помощью этого метода

KeyPair

представление пары ключей подписывания

Имя	Путь	Тип	Описание
Имя	Name	string	Имя пары ключей
DisplayNames	DisplayNames	object	Имя для каждого языка, которое будет отображаться инициатору

Common.Guid

Глобальный уникальный идентификатор

: string

Common.EmailAddress

Адрес электронной почты

: email

Common.Language

2-буквенный ISO-код страны (ISO 639-1)

: string

Common.PhoneNumber

Номер телефона

: string

Common.ExternalReference

Внешняя ссылка для пакета

: string

Common.AdditionalProperties

Настраиваемые дополнительные свойства заинтересованных лиц

Имя	Путь	Тип	Описание
		object	Настраиваемые дополнительные свойства заинтересованных лиц

Common.DateTime

Значение даты и времени в формате ISO 8601

: date-time

Package.Status

Состояние пакета

: string

Package.Name

Имя пакета

: string

Document.Name

Имя документа

: string

Document.Status

Состояние документа

: string

Document.DocumentOptions

Определяет необязательные параметры документа

Имя	Путь	Тип	Описание
Тип Цели	TargetType	string	Будет работать только в том случае, если сервер настроен для преобразования документов.
TargetFormat	PdfOptions.TargetFormat	string	Целевой формат определяет, необходимо ли выполнить дополнительное преобразование.
PdfErrorHandling	PdfOptions.PdfErrorHandling	string	Как справиться с PDF-файлами, содержащими незначительные недостатки

Заинтересованные лица.FirstName

Имя заинтересованных лиц

: string

Заинтересованные лица.LastName

Фамилия заинтересованных лиц

: string

Actor.Type

Тип действия, которое необходимо выполнить в пакете

: string

Actor.Status

Состояние субъекта

: string

Element.Type

Тип элемента

: string

Element.Status

Состояние элемента

: string

Элемент.Location

Имя	Путь	Тип	Описание
Страница	Page	integer	Номер страницы документа
Верх	Top	number	Верхняя позиция в пикселях
Лево	Left	number	Положение слева в пикселях

Element.Dimensions

Имя	Путь	Тип	Описание
Ширина	Width	number	Ширина элемента
Высота	Height	number	Высота элемента

Response.Package.Get

Имя	Путь	Тип	Описание
Идентификатор	Id	Common.Guid	Глобальный уникальный идентификатор
Имя	Name	Package.Name	Имя пакета
Initiator	Initiator	Common.EmailAddress	Адрес электронной почты
ExternalReference	ExternalReference	Common.ExternalReference	Внешняя ссылка для пакета
CreationDate	CreationDate	Common.DateTime	Значение даты и времени в формате ISO 8601
Состояние	Status	Package.Status	Состояние пакета
Срок действия	ExpiryDate	Common.DateTime	Значение даты и времени в формате ISO 8601
Documents	Documents	array of Response.Document
Заинтересованные лица	Stakeholders	array of Response.Stakeholder

Response.Document

Имя	Путь	Тип	Описание
Идентификатор	Id	Common.Guid	Глобальный уникальный идентификатор
Состояние	Status	Document.Status	Состояние документа
DocumentOptions	DocumentOptions	Document.DocumentOptions	Определяет необязательные параметры документа
Имя	Name	Document.Name	Имя документа
Language	Language	Common.Language	2-буквенный ISO-код страны (ISO 639-1)
ExternalReference	ExternalReference	Common.ExternalReference	Внешняя ссылка для пакета
ProofCorrelationId	ProofCorrelationId	Common.Guid	Глобальный уникальный идентификатор

Ответ.Заинтересованные лица

Имя	Путь	Тип	Описание
Тип	Type	string	Тип заинтересованных лиц
ExternalReference	ExternalReference	Common.ExternalReference	Внешняя ссылка для пакета
Идентификатор	Id	Common.Guid	Глобальный уникальный идентификатор
Language	Language	Common.Language	2-буквенный ISO-код страны (ISO 639-1)
Имя	FirstName	Stakeholder.FirstName	Имя заинтересованных лиц
Фамилия	LastName	Stakeholder.LastName	Фамилия заинтересованных лиц
Электронный адрес	EmailAddress	Common.EmailAddress	Адрес электронной почты
BirthDate	BirthDate	date
Номер телефона	PhoneNumber	Common.PhoneNumber	Номер телефона
AdditionalProperties	AdditionalProperties	Common.AdditionalProperties	Настраиваемые дополнительные свойства заинтересованных лиц
Actors	Actors	array of Response.Actor

Response.Actor

Имя	Путь	Тип	Описание
Тип	Type	Actor.Type	Тип действия, которое необходимо выполнить в пакете
Идентификатор	Id	Common.Guid	Глобальный уникальный идентификатор
Заинтересованные лица	StakeholderId	Common.Guid	Глобальный уникальный идентификатор
Состояние	Status	Actor.Status	Состояние субъекта
ПодавлениеNotifications	SuppressNotifications	boolean	Отключение уведомлений для субъекта
RedirectUrl	RedirectUrl	url	URL-адрес перенаправления после завершения действия субъекта
Elements	Elements	array of Response.Element

Response.Element

Имя	Путь	Тип	Описание
Тип	Type	Element.Type	Тип элемента
Идентификатор	Id	Common.Guid	Глобальный уникальный идентификатор
ActorId	ActorId	Common.Guid	Глобальный уникальный идентификатор
DocumentId	DocumentId	integer	Идентификатор документа в пакете
Состояние	Status	Element.Status	Состояние элемента
ExternalReference	ExternalReference	Common.ExternalReference	Внешняя ссылка для пакета
Местоположение	Location	Element.Location
Измерения	Dimensions	Element.Dimensions
ПодписываниеMethods	SigningMethods	array of string
UsedSigningMethod	UsedSigningMethod	string	Используемый метод подписывания

Response.Package.Status

Имя	Путь	Тип	Описание
Состояние	Status	Package.Status	Состояние пакета

бинарный

Это базовый тип данных binary.