Connective eSignatures
Connective eSignatures — это известное решение цифровой подписи, предлагающее огромное количество методов подписи и соответствия самым строгим (межнационным нормативным требованиям). eSignatures позволяет преобразовать любой бумажный процесс в сквозной цифровой поток с непарабельным взаимодействием с пользователем. Оптимизируйте процесс подписывания точно так, как вы хотите его отправлять и отправлять, подписывать и отслеживать все типы документов непосредственно из любимых бизнес-приложений. Присоединяйтесь к более чем 500 удовлетворенным клиентам.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка подключения |
| URL | https://connective.eu/contact-support/ |
| Адрес электронной почты | service@connective.eu |
| Метаданные соединителя | |
|---|---|
| Publisher | Соединительный |
| Веб-сайт | https://www.connective.eu |
| Политика конфиденциальности | https://connective.eu/privacy-policy/ |
| Категории | ИТ-операции; Продуктивность |
Connective, специалист по цифровым подписям, службам удостоверений и интеллектуальному поколению документов, сделал соединитель Connective eSignatures для Power Automate доступным для использования. Соединитель позволяет компаниям пересылать документы, требующие цифровой подписи непосредственно из любимых приложений Microsoft 365 — от Microsoft Teams до Word, SharePoint, Dynamics, OneDrive и многих других.
Начало работы с соединителем
Чтобы начать использовать соединитель, обратитесь к диспетчеру связей в Connective или перейдите на нашу страницу контакта на нашем веб-сайте, чтобы получить учетные данные.
На этой странице будут подробно описаны различные доступные действия, а также сведения о различных способах реализации этих действий.
Не стесняйтесь ознакомиться с нашим веб-сайтом документации для получения дополнительных сведений или обратиться к группе поддержки через форму или почтовый ящик поддержки: service@connective.eu
Глоссарий доступен для объяснения различных терминов, используемых в этой документации.
Действия
Соединитель Connective eSignatures основан на API версии 3 eSignatures. API eSignatures — это REST API, который позволяет внешним приложениям интегрироваться и использовать функции, перечисленные в этом документе, для создания потоков подписывания и управления ими.
Доступные действия можно сгруппировать в разные группы
| Группа действий | Доступные действия |
|---|---|
| Отправка документов | Создание пакета |
| Добавление документа в пакет | |
| Получение расположений подписи | |
| Настройка сведений о процессе | |
| Установка состояния пакета | |
| Создание мгновенного пакета | |
| Получение состояния документа | Получение состояния пакета |
| Получение списка пакетов | |
| Другие действия | Пропускающие подписи |
| Скачивание пакета | |
| Расширение срока действия пакета | |
| Отправка напоминания о пакете | |
| Удаление пакета | |
| Получение подтверждения аудита | Получение проверки аудита пакетов |
| Получение доказательств аудита документов | |
| Получение проверки аудита пакета с идентификатором корреляции | |
| Получение доказательств аудита документов с помощью идентификатора корреляции | |
| Добавление подтверждения из внешнего источника |
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Url-адрес среды Connective eSignatures | струна | URL-адрес среды Connective eSignatures, например. esignatures.connective.eu | True |
| Имя пользователя API | securestring | Имя пользователя API для доступа к API | True |
| Пароль API | securestring | Пароль API для доступа к API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Добавление документа в пакет |
Этот вызов добавит документ в существующий пакет. |
| Добавление подтверждения из внешнего источника |
Этот вызов позволяет пользователям API добавлять дополнительные доказательства из внешнего источника в расположение документа. |
| Метка времени истечения срока действия |
Пакет может иметь состояние с истекшим сроком действия, когда пакет передал значение параметра ExpiryTimestamp в вызове create Package. Такой пакет больше не может быть подписан. |
| Настройка сведений о процессе |
Этот метод веб-службы обновляет людей, участвующих в процессе (заинтересованных лиц), и назначает им шаги, которые необходимо предпринять. |
| Отправка напоминаний о пакете |
Политика компании может потребовать, чтобы документ обрабатывался в пределах заданного интервала времени. Активация вызова "отправки напоминаний" будет искать всех, кто не подписал, и отправить им дополнительное уведомление в качестве напоминания. |
| Подтверждение аудита пакета |
Xml-код проверки аудита пакета можно получить при полном подписании пакета. То же самое относится к документу: он работает только в том случае, если содержащий пакет полностью подписан. |
| Подтверждение аудита пакета с идентификатором документа |
Xml-код проверки аудита пакета можно получить при полном подписании пакета. То же самое относится к документу: он работает только в том случае, если содержащий пакет полностью подписан. |
| Получение расположений подписи |
Этот вызов содержит обзор всех расположений подписывания в документах в пакете. |
| Получение состояния пакета |
Извлекает текущее состояние пакета и его документов. |
| Пропускающие подписи |
Этот вызов пропускает все подписи, которые еще не подписаны, и задает состояние "Пропущено", что приводит к тому, что полный пакет помечается как "Готово". |
| Скачивание документа из пакета |
Подписанные документы в пакете можно скачать по одному внешней системой с помощью этого вызова. Каждый документ будет скачан в формате PDF или в виде потока XML-файла в зависимости от значения параметра DocumentType. |
| Скачивание пакета |
Пакет, содержащий подписанные документы, можно скачать внешней системой с помощью этого вызова. |
| Скачивание проверки корреляции документов |
Идентификаторы корреляции используются для отслеживания пакетов или документов в нескольких проходах через приложение eSignatures. |
| Скачивание проверки корреляции пакетов |
Идентификаторы корреляции используются для отслеживания пакетов или документов в нескольких проходах через приложение eSignatures. |
| Создание мгновенного пакета |
Этот вызов создает пакет с одним документом в нем и мгновенно подготавливает его к подписи |
| Создание пакета |
Этот вызов создает пустой пакет, позволяющий добавлять в него документы |
| Список пакетов |
Получение списка пакетов с текущим состоянием |
| Удаление пакета |
eSignatures не удаляет пакеты из базы данных автоматически после достижения окончательного состояния. Они хранятся бесконечно. Чтобы удалить пакеты из базы данных, пользователи могут использовать вызов "Удалить пакет". |
| Установка состояния пакета |
С помощью вызова "Задать состояние пакета" можно изменить состояние пакета. |
Добавление документа в пакет
Этот вызов добавит документ в существующий пакет.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пакета.
|
PackageId | True | string |
Уникальный идентификатор пакета |
|
Документ
|
Document | string |
Присоединенный документ в кодировке Base64. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Язык для использования в сигнатурных текстах. |
|
|
Имя документа
|
DocumentName | string |
Имя документа, отображаемого на портале eSignatures. |
|
|
PageNumber
|
PageNumber | integer |
Номер страницы, на которой нужно добавить расположение подписи |
|
|
Ширина
|
Width | string |
Ширина |
|
|
Высота
|
Height | string |
Высота |
|
|
Лево
|
Left | string |
Позиция слева от страницы |
|
|
Верх
|
Top | string |
Позиция в верхней части страницы |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Уникальная ссылка на поле подписывания, текстовый маркер или текстовое поле. |
|
|
CorrelationId
|
CorrelationId | string |
Идентификатор, указывающий, какие документы в этом пакете коррелируются с документами, которые были подписаны в прошлом в других пакетах. |
|
|
DocumentType
|
DocumentType | string |
Тип документа, который будет подписан. |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Ссылка, указанная вызывающим приложением. |
|
|
ErrorCode
|
ErrorCode | string |
Код ошибки с сведениями об переменной. |
|
|
Message
|
Message | string |
Текст сообщения об ошибке, не локализованный |
|
|
Представление
|
Representation | string |
Присоединенный документ представления в формате base64. Это должны быть PDF-данные. |
|
|
ПредставлениеType
|
RepresentationType | string |
Тип документа представления. |
|
|
Тип Цели
|
TargetType | string |
TargetType определяет, необходимо ли выполнить дополнительное преобразование в PDF/A перед подписанием. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Уникальный идентификатор документа |
|
CreationTimestamp
|
CreationTimestamp | string |
Дата и время создания потока. Формат: ГГГГ-ММ-ДДThh:мм:ss+zz:zz:zz |
|
Locations
|
Locations | array of object |
Представляет возможное расположение для подписи |
|
Идентификатор
|
Locations.Id | string |
Уникальный идентификатор для этого расположения |
|
Этикетка
|
Locations.Label | string |
Обнаруженная или указанная метка |
|
PageNumber
|
Locations.PageNumber | integer |
Страница, на которой найдено расположение. |
Добавление подтверждения из внешнего источника
Этот вызов позволяет пользователям API добавлять дополнительные доказательства из внешнего источника в расположение документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
packageId | True | string |
Уникальный идентификатор пакета |
|
Content
|
Content | string |
Фактическое содержимое доказательства. |
|
|
LocationId
|
LocationId | string |
Расположение подписи, для которой создано содержимое подтверждения. |
|
|
Имя
|
Name | string |
Имя доказательства. |
|
|
Тип
|
Type | string |
Ключ типа, доступный для чтения компьютера. Можно свободно выбрать. |
|
|
Description
|
Description | string |
Краткое описание доказательства, доступное для чтения человеком. |
|
|
IP-адрес
|
IpAddress | string |
IP-адрес конечного пользователя внешнего источника, для которого был добавлен подтверждение. |
Метка времени истечения срока действия
Пакет может иметь состояние с истекшим сроком действия, когда пакет передал значение параметра ExpiryTimestamp в вызове create Package. Такой пакет больше не может быть подписан.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
id | True | string |
Уникальный идентификатор пакета |
|
ExpiryTimestamp
|
ExpiryTimestamp | date-time |
Настройка сведений о процессе
Этот метод веб-службы обновляет людей, участвующих в процессе (заинтересованных лиц), и назначает им шаги, которые необходимо предпринять.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
id | True | string |
Уникальный идентификатор пакета |
|
Тип
|
Type | string |
Тип |
|
|
OrderIndex
|
OrderIndex | string |
Это число указывает, в каком порядке субъекты должны выполнять свое действие. |
|
|
LocationIds
|
LocationIds | array of string |
Идентификаторы расположения, в которых подпись должна размещаться этим человеком. |
|
|
ПодписываниеType
|
SigningType | string |
Тип подписи, используемый в сеансе субъекта. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Один или несколько типов обязательств. Можно передавать только при использовании политики подписи. |
|
|
Обязательное назначениеSignerValidation
|
MandatedSignerValidation | string |
Тип проверки для выполнения во время eID других смарт-карт или сеанса подписывания itsme. |
|
|
Обязательные идентификаторыSignerIds
|
MandatedSignerIds | array of string |
Определяет, какие электронные идентификаторы или другие смарт-карты разрешены для входа во время этого сеанса. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Сведения о политике подписи для подписи. |
|
|
Номер телефона
|
Phonenumber | string |
Номер телефона для получения SMS OTP. |
|
|
RedirectURL
|
RedirectURL | string |
URL-адрес, на который перенаправляется конечный пользователь после подписания или отклонения. Перенаправление происходит сразу после подписывания или отклонения. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures может отправлять сообщения электронной почты субъектам, действия которых требуются, например подписывание |
|
|
UserRoles
|
UserRoles | array of string |
Идентификаторы расположения, в которых подпись должна размещаться этим человеком. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
3 значения указывают на 3 юридических уведомления, встроенные в приложение. Их можно изменить в индексе конфигурации. |
|
|
LegalNoticetext
|
LegalNoticetext | string |
Текст пользовательского юридического уведомления в случае, если ни одно из трех предопределенных юридических уведомлений не применяется |
|
|
Электронный адрес
|
EmailAddress | string |
Электронная почта |
|
|
Имя
|
FirstName | string |
Имя (Первое имя) |
|
|
Language
|
Language | string |
Язык пользовательского интерфейса этого заинтересованных лиц. В настоящее время поддерживается: en, nl, de, fr, es. |
|
|
Фамилия
|
LastName | string |
Фамилия |
|
|
BirthDate
|
BirthDate | string |
Дата рождения в формате: ГГГГ-MM-DD |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
Ссылка, указанная вызывающим приложением. Этот параметр не будет использоваться порталом eSignatures. |
Отправка напоминаний о пакете
Политика компании может потребовать, чтобы документ обрабатывался в пределах заданного интервала времени. Активация вызова "отправки напоминаний" будет искать всех, кто не подписал, и отправить им дополнительное уведомление в качестве напоминания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
PackageId | True | string |
Уникальный идентификатор пакета |
Подтверждение аудита пакета
Xml-код проверки аудита пакета можно получить при полном подписании пакета. То же самое относится к документу: он работает только в том случае, если содержащий пакет полностью подписан.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
packageId | True | string |
Уникальный идентификатор пакета |
Возвращаемое значение
- Тело
- Content
Подтверждение аудита пакета с идентификатором документа
Xml-код проверки аудита пакета можно получить при полном подписании пакета. То же самое относится к документу: он работает только в том случае, если содержащий пакет полностью подписан.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
packageId | True | string |
Уникальный идентификатор пакета |
|
Уникальный идентификатор документа
|
documentId | True | string |
Уникальный идентификатор документа |
Возвращаемое значение
- Тело
- Content
Получение расположений подписи
Этот вызов содержит обзор всех расположений подписывания в документах в пакете.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор поля подписывания
|
Id | True | string |
Идентификатор поля подписывания |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Documents
|
Documents | array of object | |
|
DocumentId
|
Documents.DocumentId | string |
Уникальный идентификатор документа |
|
ExternalDocumentReference
|
Documents.ExternalDocumentReference | string |
Внешняя ссылка для идентификации. Обязательно используйте уникальное значение. |
|
Locations
|
Documents.Locations | array of object |
Представляет возможное расположение для подписи |
|
Идентификатор
|
Documents.Locations.Id | string |
Уникальный идентификатор для этого расположения. |
|
Этикетка
|
Documents.Locations.Label | string |
Значение, введенное в качестве параметра request. |
|
PageNumber
|
Documents.Locations.PageNumber | integer |
Номер страницы, на которой можно найти подпись. |
Получение состояния пакета
Извлекает текущее состояние пакета и его документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета подписывания
|
Id | True | string |
Уникальный идентификатор пакета подписывания |
Возвращаемое значение
Описание пакета, отображаемого пользователю портала eSignatures в качестве имени файла.
- Тело
- PackageStatus
Пропускающие подписи
Этот вызов пропускает все подписи, которые еще не подписаны, и задает состояние "Пропущено", что приводит к тому, что полный пакет помечается как "Готово".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
PackageId | True | string |
Уникальный идентификатор пакета |
Скачивание документа из пакета
Подписанные документы в пакете можно скачать по одному внешней системой с помощью этого вызова. Каждый документ будет скачан в формате PDF или в виде потока XML-файла в зависимости от значения параметра DocumentType.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета подписывания
|
id | True | string |
Уникальный идентификатор пакета подписывания |
|
Уникальный идентификатор документа, содержащегося в пакете
|
documentId | True | string |
Уникальный идентификатор документа, содержащегося в пакете |
Возвращаемое значение
- response
- binary
Скачивание пакета
Пакет, содержащий подписанные документы, можно скачать внешней системой с помощью этого вызова.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
id | True | string |
Уникальный идентификатор пакета |
Возвращаемое значение
- response
- binary
Скачивание проверки корреляции документов
Идентификаторы корреляции используются для отслеживания пакетов или документов в нескольких проходах через приложение eSignatures.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор корреляции.
|
correlationId | True | string |
Идентификатор корреляции. |
Возвращаемое значение
- Тело
- Content
Скачивание проверки корреляции пакетов
Идентификаторы корреляции используются для отслеживания пакетов или документов в нескольких проходах через приложение eSignatures.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор корреляции.
|
correlationId | True | string |
Идентификатор корреляции. |
Возвращаемое значение
- Тело
- Content
Создание мгновенного пакета
Этот вызов создает пакет с одним документом в нем и мгновенно подготавливает его к подписи
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Документ
|
Document | byte |
Присоединенный документ в кодировке Base64. Требуется, если не используется многопартийный формат. |
|
|
DocumentLanguage
|
DocumentLanguage | string |
Язык для использования в сигнатурных текстах. В настоящее время поддерживается: en, nl, de, fr, es. |
|
|
Имя документа
|
DocumentName | string |
Имя документа и пакета, отображаемых на портале eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
ExternalPackageData |
|
|
Initiator
|
Initiator | string |
Адрес электронной почты зарегистрированного пользователя |
|
|
Тип
|
Type | string |
Подписыватель / приемник |
|
|
OrderIndex
|
OrderIndex | integer |
Это число указывает, в каком порядке субъекты должны выполнять свое действие. |
|
|
PageNumber
|
PageNumber | integer |
Номер страницы, на которой нужно добавить расположение подписи |
|
|
Ширина
|
Width | string |
Ширина |
|
|
Высота
|
Height | string |
Высота |
|
|
Лево
|
Left | string |
Позиция слева от страницы |
|
|
Верх
|
Top | string |
Позиция в верхней части страницы |
|
|
MarkerOrFieldId
|
MarkerOrFieldId | string |
Уникальная ссылка на поле подписывания, текстовый маркер или текстовое поле. |
|
|
ПодписываниеType
|
SigningType | string |
Тип подписи, используемый в сеансе субъекта. |
|
|
CommitmentTypes
|
CommitmentTypes | array of string |
Один или несколько типов обязательств. Можно передавать только при использовании политики подписи. |
|
|
Обязательное назначениеSignerValidation
|
MandatedSignerValidation | string |
Тип проверки для выполнения во время eID других смарт-карт или сеанса подписывания itsme. |
|
|
Обязательные идентификаторыSignerIds
|
MandatedSignerIds | array of string |
Определяет, какие электронные идентификаторы или другие смарт-карты разрешены для входа во время этого сеанса. |
|
|
SignaturePolicyId
|
SignaturePolicyId | string |
Сведения о политике подписи для подписи. |
|
|
Номер телефона
|
Phonenumber | string |
Номер телефона для получения SMS OTP. |
|
|
RedirectUrl
|
RedirectUrl | string |
URL-адрес, на который перенаправляется конечный пользователь после подписания. |
|
|
SendNotifications
|
SendNotifications | boolean |
eSignatures может отправлять сообщения электронной почты всем пользователям, которым разрешено подписаться. |
|
|
UserRoles
|
UserRoles | array of string |
Роль или функция подписывающего элемента. |
|
|
LegalNoticeCode
|
LegalNoticeCode | string |
Юридическое уведомление |
|
|
LegalNoticeText
|
LegalNoticeText | string |
Текст пользовательского юридического уведомления в случае, если ни один из трех предопределенных юридических уведомлений не применяется. |
|
|
Электронный адрес
|
EmailAddress | string |
Электронный адрес |
|
|
Имя
|
FirstName | string |
Имя |
|
|
Фамилия
|
LastName | string |
Фамилия |
|
|
BirthDate
|
BirthDate | string |
BirthDate |
|
|
Language
|
Language | string |
Language |
|
|
ExternalStakeholderReference
|
ExternalStakeholderReference | string |
ExternalStakeholderReference |
|
|
CallBackUrl
|
CallBackUrl | string |
URL-адрес REST API, который будет вызываться при каждом завершении действия для этого пакета |
|
|
CorrelationId
|
CorrelationId | string |
Идентификатор, указывающий, какие пакеты или документы коррелируются |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Код, определяющий группу документов, в которой должен отображаться документ |
|
|
ThemeCode
|
ThemeCode | string |
Тема, которая должна быть применена к пакету |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Этот параметр определяет, можно ли скачать пакеты из WYSIWYS перед подписью |
|
|
ПереназначениеEnabled
|
ReassignEnabled | boolean |
Этот параметр определяет, можно ли переназначить пакеты из WYSIWYS в другой утверждающий или подписыватель. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Этот параметр определяет, сколько дней срок действия должен истекает, когда они не используются. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Ссылка, указанная вызывающим приложением. Этот параметр не будет использоваться порталом eSignatures |
|
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Ссылка, указанная вызывающим приложением, этот параметр не будет использоваться порталом eSignatures |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Ссылка, указанная вызывающим приложением, этот параметр не будет использоваться порталом eSignatures |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL-адрес, на который перенаправляется конечный пользователь после того, как все поля были подписаны с подписью лицом к лицу или когда все поля были отклонены. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL-адрес REST API, который будет вызываться, когда конечный пользователь запрашивает уведомления. Если URL-адрес не указан, обратный вызов не выполняется |
|
|
PdfErrorHandling
|
PdfErrorHandling | string |
Как справиться с PDF-файлами, содержащими незначительные недостатки |
|
|
Представление
|
Representation | string |
Присоединенный документ представления в формате base64 |
|
|
ПредставлениеType
|
RepresentationType | string |
Тип документа представления должен присутствовать при заполнении представления. Поддерживается только application/pdf. |
|
|
ПодписьTemplateCode
|
SigningTemplateCode | string |
Шаблон, настроенный на портале, предоставит все необходимые сведения |
|
|
Тип Цели
|
TargetType | string |
TargetType определяет, необходимо ли выполнить дополнительное преобразование в PDF/A перед подписанием |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Уникальный идентификатор пакета. |
|
CreationTimestamp
|
CreationTimestamp | string |
Дата и время создания пакета в соответствии с сервером. |
Создание пакета
Этот вызов создает пустой пакет, позволяющий добавлять в него документы
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип контента
|
Content-Type | True | string |
Тип контента |
|
Initiator
|
Initiator | string |
Адрес электронной почты зарегистрированного пользователя. |
|
|
PackageName
|
PackageName | string |
Имя пакета, отображаемого на портале eSignatures и при скачивании в виде ZIP-файла. |
|
|
CallBackUrl
|
CallBackUrl | string |
URL-адрес REST API, который будет вызываться при каждом завершении действия для этого пакета. |
|
|
CorrelationId
|
CorrelationId | string |
Идентификатор, указывающий, какие пакеты коррелируются. |
|
|
DocumentGroupCode
|
DocumentGroupCode | string |
Код, определяющий группу документов, в которой должен отображаться пакет. |
|
|
ThemeCode
|
ThemeCode | string |
Тема, которая должна быть применена к пакету |
|
|
DownloadUnsignedFiles
|
DownloadUnsignedFiles | boolean |
Этот параметр определяет, можно ли скачать пакеты из WYSIWYS перед подписью. |
|
|
ПереназначениеEnabled
|
ReassignEnabled | boolean |
Этот параметр определяет, можно ли переназначить пакеты из WYSIWYS в другой утверждающий или подписыватель. |
|
|
ActionUrlExpirationPeriodInDays
|
ActionUrlExpirationPeriodInDays | integer |
Этот параметр определяет, сколько дней срок действия должен истекает, когда они не используются. |
|
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Дата и время истечения срока действия этого пакета и его невозможно подписать. |
|
|
ExternalPackageReference
|
ExternalPackageReference | string |
Ссылка, указанная вызывающим приложением. Этот параметр не будет использоваться порталом eSignatures. |
|
|
ExternalPackageData
|
ExternalPackageData | string |
Это поле зарезервировано для дальнейшего использования. Его можно использовать для расширений, относящихся к клиенту, для интеграции со сторонними службами, такими как подпись дебетовой карты. |
|
|
F2FRedirectUrl
|
F2FRedirectUrl | string |
URL-адрес, на который перенаправляется конечный пользователь после того, как все поля были подписаны с подписью "лицом к лицу" или когда все поля были отклонены. |
|
|
NotificationCallBackUrl
|
NotificationCallBackUrl | string |
URL-адрес REST API, который будет вызываться, когда конечный пользователь запрашивает уведомления. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PackageId
|
PackageId | string |
Уникальный идентификатор пакета. |
|
CreationTimestamp
|
CreationTimestamp | string |
Дата и время создания пакета в соответствии с сервером. |
Список пакетов
Получение списка пакетов с текущим состоянием
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер продолжения или guid, чтобы узнать, какая страница требуется вернуть.
|
ContinuationToken | string |
Маркер продолжения или guid, чтобы узнать, какая страница требуется вернуть. ДОЛЖЕН БЫТЬ ПУСТЫм или маркером, возвращенным из предыдущего вызова. |
|
|
Возвращает или задает максимальное количество.
|
MaxQuantity | integer |
Возвращает или задает максимальное количество. |
|
|
Возвращает или задает поле сортировки.
|
SortField | string |
Возвращает или задает поле сортировки. |
|
|
Возвращает или задает поле сортировки.
|
SortOrder | string |
Возвращает или задает поле сортировки. |
|
|
Возвращает или задает созданную дату.
|
CreatedBeforeDate | string |
Возвращает или задает созданную дату. |
|
|
Возвращает или задает состояние.
|
Status | string |
Возвращает или задает состояние. |
|
|
Возвращает или задает созданный после даты.
|
createdAfterDate | string |
Возвращает или задает созданный после даты. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Токен продолжения
|
ContinuationToken | string |
Токен продолжения |
|
MaxQuantity
|
MaxQuantity | integer |
MaxQuantity |
|
Total
|
Total | integer |
Total |
|
Товары
|
Items | array of Package |
Удаление пакета
eSignatures не удаляет пакеты из базы данных автоматически после достижения окончательного состояния. Они хранятся бесконечно. Чтобы удалить пакеты из базы данных, пользователи могут использовать вызов "Удалить пакет".
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета
|
id | True | string |
Уникальный идентификатор пакета |
Установка состояния пакета
С помощью вызова "Задать состояние пакета" можно изменить состояние пакета.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Уникальный идентификатор пакета подписывания
|
Id | True | string |
Уникальный идентификатор пакета подписывания |
|
Состояние
|
Status | string |
Ожидание или отмена |
Возвращаемое значение
Описание пакета, отображаемого пользователю портала eSignatures в качестве имени файла.
- Тело
- PackageStatus
Определения
Package
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
Id | string | |
|
PackageStatus
|
PackageStatus | string | |
|
ExternalPackageReference
|
ExternalPackageReference | string |
PackageDocument
Сведения о каждом из документов в пакете
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
DocumentId
|
DocumentId | string |
Уникальный идентификатор документа |
|
ExternalDocumentReference
|
ExternalDocumentReference | string |
Возвращает внешнюю ссылку на этот документ, как он был передан с помощью документа Add document to package call. |
|
Имя документа
|
DocumentName | string |
Имя документа |
|
DocumentType
|
DocumentType | string |
Тип документа в пакете. |
PackageStatus
Описание пакета, отображаемого пользователю портала eSignatures в качестве имени файла.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
PackageName
|
PackageName | string |
Описание пакета, отображаемого пользователю портала eSignatures в качестве имени файла. |
|
CreationTimestamp
|
CreationTimestamp | string |
Дата и время создания пакета в соответствии с сервером. |
|
Initiator
|
Initiator | string |
Поле инициатора пакета, передаваемого во время создания. |
|
ExpiryTimestamp
|
ExpiryTimestamp | string |
Время в формате UTC, в течение которого истекает срок действия документа. Может иметь значение NULL. |
|
ExternalPackageReference
|
ExternalPackageReference | string |
Возвращает внешний идентификатор ссылки пакета по мере его прохождения во время создания. |
|
F2FSigningUrl
|
F2FSigningUrl | string |
Ссылка на пакет, который позволяет выбрать один раз из всего сеанса подписывания. |
|
PackageStatus
|
PackageStatus | string |
Состояние пакета в целом: |
|
PackageDocuments
|
PackageDocuments | array of PackageDocument |
Сведения о каждом из документов в пакете. |
|
Заинтересованные лица
|
Stakeholders | array of object |
Сведения о каждом из лиц, которые будут взаимодействовать с пакетом. |
|
Тип
|
Stakeholders.Type | string |
Тип заинтересованных лиц: Person, PersonGroup или ContactGroup. |
|
PersonGroupName
|
Stakeholders.PersonGroupName | string |
Имя группы пользователей. Возвращается только в том случае, если в запросе задано значение Type PersonGroup. |
|
ContactGroupCode
|
Stakeholders.ContactGroupCode | string |
Код группы контактов. Возвращается только в том случае, если тип был задан в contactGroup в запросе. |
|
Электронный адрес
|
Stakeholders.EmailAddress | string |
Адрес электронной почты подписывчика. |
|
ExternalStakeholderReference
|
Stakeholders.ExternalStakeholderReference | string |
Внешняя ссылка, определяющая этого человека во внешней системе. |
|
Заинтересованные лица
|
Stakeholders.StakeholderId | string |
Уникальный идентификатор. |
|
Actors
|
Stakeholders.Actors | array of object |
Подробные сведения обо всех шагах, которые необходимо выполнить. |
|
ActorId
|
Stakeholders.Actors.ActorId | string |
Уникальный идентификатор для этого сочетания действий, заинтересованных лиц и документов. |
|
ActionUrl
|
Stakeholders.Actors.ActionUrl | string |
URL-адрес, который этот пользователь может открыть для взаимодействия с пакетом. |
|
ActionUrls
|
Stakeholders.Actors.ActionUrls | array of object |
Массив URL-адресов, которые могут открывать разные лица PersonGroup или ContactGroup для взаимодействия с пакетом. |
|
Электронный адрес
|
Stakeholders.Actors.ActionUrls.EmailAddress | string |
Адрес электронной почты пользователя. |
|
URL-адрес
|
Stakeholders.Actors.ActionUrls.Url | string |
URL-адрес, который этот пользователь может открыть для взаимодействия с пакетом. |
|
ActorStatus
|
Stakeholders.Actors.ActorStatus | string |
Черновик (пакет имеет состояние "Черновик") |
|
Тип
|
Stakeholders.Actors.Type | string |
Подписыватель / приемник |
|
CompletedBy
|
Stakeholders.Actors.CompletedBy | string |
Имя конечного пользователя, выполнившего действие. |
|
CompletedTimestamp
|
Stakeholders.Actors.CompletedTimestamp | string |
Метка времени завершения этого действия. |
|
Причина
|
Stakeholders.Actors.Reason | string |
Возвращает текст, введенный пользователем, который изменил состояние пакета на окончательное состояние (например, отклонение). |
|
Locations
|
Stakeholders.Actors.Locations | array of object |
Представляет возможное расположение для подписи. |
|
Идентификатор
|
Stakeholders.Actors.Locations.Id | string |
Уникальный идентификатор для этого расположения |
|
UsedSigningType
|
Stakeholders.Actors.Locations.UsedSigningType | string |
Возвращает тип подписи, используемый для подписи документа. |
Content
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Загрузки
|
uploads | array of object | |
|
загрузить
|
uploads.upload | array of object | |
|
start
|
uploads.upload.start | date-time | |
|
конец
|
uploads.upload.end | date-time | |
|
Подписи
|
uploads.upload.signatures | array of object | |
|
Доказательства
|
uploads.upload.signatures.proofs | array of object | |
|
имя
|
uploads.upload.signatures.proofs.proof.name | string | |
|
type
|
uploads.upload.signatures.proofs.proof.type | string | |
|
index
|
uploads.upload.signatures.proofs.proof.index | boolean | |
|
ipAddress
|
uploads.upload.signatures.proofs.proof.ipAddress | string | |
|
locationId
|
uploads.upload.signatures.locationId | string | |
|
индексы
|
uploads.indexes | array of object | |
|
идентификатор
|
uploads.indexes.index.identifier | boolean | |
|
содержимое
|
uploads.indexes.index.content | string | |
|
packageCorrelationId
|
uploads.packageCorrelationId | string | |
|
Идентификатор пакета
|
uploads.packageId | string |
бинарный
Это базовый тип данных binary.