Certinal eSign (предварительная версия)
Certinal eSign позволяет предприятиям безопасно отправлять, подписывать и управлять документами с глобальными требованиями eSignatures. Предназначено для регулируемых отраслей, Certinal обеспечивает отслеживание рабочих процессов в режиме реального времени, путь аудита, а также простое автоматизацию. Используйте Certinal eSign в рабочих процессах для оцифровки утверждений, ускорения процессов и обеспечения юридически допустимых подписей в 70+ странах.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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://www.certinal.com/department/esignature-for-support |
| Адрес электронной почты | tech-support@certinal.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Certinal Inc. |
| Веб-сайт | https://www.certinal.com/ |
| Политика конфиденциальности | https://www.certinal.com/privacy-policy |
| Категории | Продуктивность; Управление бизнесом |
Certinal eSign
Обзор
Certinal eSign предоставляет безопасные, совместимые рабочие процессы eSignature и eConsent для глобальных предприятий— отправлять, подписывать, отслеживать и управлять документами непосредственно из Power Automate.
Предпосылки
Для использования триггера соединителя необходимо иметь учетную запись администратора Certinal. Чтобы использовать триггер соединителя в этой интеграции, в параметрах администратора Certinal необходимо включить Power Connector.
Получение учетных данных
Certinal использует ключ API для проверки подлинности служб. Необходимо создать ключ API из учетной записи администратора Certinal.
Поддерживаемые операции
Соединитель поддерживает следующие операции:
Получение сведений о транзакции
Получение сведений о транзакции по идентификатору транзакции
Скачивание документов для транзакции
Скачивание документов для заданного идентификатора транзакции
Создание транзакции
Создание транзакции
Создание транзакции с помощью шаблона
Создание транзакции с помощью заданного идентификатора шаблона
Список пользователей
Список пользователей
Получение сведений о пользователе
Получение сведений о пользователе для заданного идентификатора пользователя
Создание пользователя
Создание пользователя
Поддерживаемые триггеры
Соединитель поддерживает следующие триггеры:
Изменение состояния транзакции
Регистрация обратного вызова для определенного события транзакции
Документы API:
https://certinal.stoplight.io/docs/api/72b66de24898e-introduction
https://www.postman.com/certinal/workspace/certinal-public-workspace/overview
Справка и поддержка
https://esign.certinal.com/esign/certinal-docs/help-support
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Ключ API | securestring | Ключ API для этого API | True |
| Базовая конечная точка API | струна | Базовый URL-адрес конечной точки API (например, api.certinal.com) | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Получение сведений о пользователе |
Получение сведений о пользователе для заданного идентификатора пользователя |
| Получение сведений о транзакции |
Получение сведений о транзакции по идентификатору транзакции |
| Скачивание документов для транзакции |
Скачивание документов для заданного идентификатора транзакции |
| Создание пользователя |
Создание пользователя |
| Создание транзакции |
Создание транзакции |
| Создание транзакции с помощью шаблона |
Создание транзакции с помощью заданного идентификатора шаблона |
| Список пользователей |
Список пользователей |
| Удалить подписку |
Удалить подписку |
Получение сведений о пользователе
Получение сведений о пользователе для заданного идентификатора пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор пользователя
|
userId | True | string |
Уникальный идентификатор пользователя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
Имя (Первое имя)
|
data.firstName | string |
Имя (Первое имя) |
|
Фамилия
|
data.lastName | string |
Фамилия |
|
Компания
|
data.company | string |
Компания |
|
Часовой пояс
|
data.timezone | string |
Часовой пояс |
|
Language
|
data.language | string |
Language |
|
DateFormat
|
data.dateFormat | string |
DateFormat |
|
Должность
|
data.jobTitle | string |
Должность |
|
Номер телефона
|
data.phoneNumber | string |
Номер телефона |
|
Код страны
|
data.phoneCountryCode | string |
Код страны |
|
Роли
|
data.roles | array of string |
Роли |
|
Отключена ли окончательная почта?
|
data.finalMailDisabled | boolean |
Отключена ли окончательная почта? |
|
Отключена ли почта напоминания?
|
data.reminderMailDisabled | boolean |
Отключена ли почта напоминания? |
|
Отключена ли почта отправителя?
|
data.senderMailDisabled | boolean |
Отключена ли почта отправителя? |
|
Пользователь интеграции?
|
data.integrationUser | boolean |
Пользователь интеграции? |
|
Salutation
|
data.salutation | string |
Salutation |
|
Активен
|
data.active | boolean |
Активен |
|
Идентификатор
|
data.id | string |
Идентификатор |
|
Электронная почта
|
data.emailAddress | string |
Электронная почта |
Получение сведений о транзакции
Получение сведений о транзакции по идентификатору транзакции
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ИД транзакции
|
transactionId | True | string |
Уникальный идентификатор транзакции |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
Имя транзакции
|
data.name | string |
Имя транзакции |
|
Состояние транзакции
|
data.status | string |
Состояние транзакции |
|
ИД транзакции
|
data.transactionId | string |
ИД транзакции |
|
Message
|
data.mail.message | string |
Сообщение для всех участников электронной почты. |
|
Дата последнего обновления
|
data.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.createdDate | string |
Дата создания |
|
Идентификатор пользователя
|
data.createdBy.id | string |
Создан идентификатором пользователя |
|
Имя пользователя
|
data.createdBy.username | string |
Создано с помощью имени пользователя |
|
Электронная почта
|
data.createdBy.emailAddress | string |
Создан по адресу электронной почты |
|
Дата отправки
|
data.sentDate | string |
Дата отправки |
|
Идентификатор пользователя
|
data.lastActionPerformedBy.userId | string |
Идентификатор пользователя |
|
Имя пользователя
|
data.lastActionPerformedBy.userName | string |
Имя пользователя |
|
Электронная почта
|
data.lastActionPerformedBy.emailAddress | string |
Электронная почта |
|
Идентификатор кандидата
|
data.lastActionPerformedBy.candidateId | string |
Идентификатор кандидата |
|
Идентификатор участника
|
data.lastActionPerformedBy.participantId | string |
Идентификатор участника |
|
Срок действия метки времени
|
data.expiryAndReminders.expiresAtTimestamp | string |
Срок действия транзакции истекает в метку времени |
|
Срок действия дней
|
data.expiryAndReminders.expiryDays | integer |
Срок действия дней |
|
Напоминание из дней напоминания
|
data.expiryAndReminders.remindFromReminderDays | integer |
Напоминание из дней напоминания |
|
Напоминание из времени напоминания
|
data.expiryAndReminders.remindFromReminderTime | string |
Напоминание из времени напоминания |
|
Частота напоминаний
|
data.expiryAndReminders.reminderFrequency | integer |
Частота напоминания |
|
Участники
|
data.participants | array of object |
Участники |
|
Идентификатор участника
|
data.participants.id | string |
Идентификатор участника |
|
Состояние участника
|
data.participants.status | string |
Состояние участника |
|
Дата последнего обновления
|
data.participants.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.participants.createdDate | string |
Дата создания |
|
Последовательность участника
|
data.participants.sequence | integer |
Последовательность |
|
Role
|
data.participants.role | string |
Role |
|
Метод подписи
|
data.participants.signingMethodDTO | array of string |
Сведения о методе подписывания |
|
Отправлено пользователем
|
data.participants.submittedBys | array of object |
Отправлены сведениями пользователя |
|
Идентификатор пользователя
|
data.participants.submittedBys.userId | string |
Отправлен идентификатором пользователя |
|
Имя пользователя
|
data.participants.submittedBys.userName | string |
Отправлено именем пользователя |
|
Электронная почта
|
data.participants.submittedBys.emailAddress | string |
Отправлен по адресу электронной почты пользователя |
|
Идентификатор кандидата
|
data.participants.submittedBys.candidateId | string |
Идентификатор кандидата |
|
Кандидатов
|
data.participants.candidates | array of object |
Кандидатов |
|
Идентификатор кандидата
|
data.participants.candidates.id | string |
Идентификатор кандидата |
|
Имя
|
data.participants.candidates.name | string |
Имя кандидата |
|
Электронная почта
|
data.participants.candidates.emailAddress | string |
Адрес электронной почты кандидата |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Тип
|
data.participants.candidates.type | string |
Тип |
|
Действие
|
data.participants.candidates.action | string |
Действие |
|
Дата действия
|
data.participants.candidates.actionDate | string |
Дата действия |
|
Дата создания
|
data.participants.candidates.createdDate | string |
Дата создания |
|
Значение режима проверки подлинности
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Значение режима проверки подлинности |
|
Сведения о методе подписывания
|
data.participants.candidates.signingMethodDTO | array of string |
Сведения о методе подписывания |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Каналы доставки
|
data.participants.candidates.deliveryChannels | array of string |
Каналы доставки |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Идентификатор
|
data.participants.fields.id | string |
Идентификатор |
|
Дата последнего обновления
|
data.participants.fields.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.participants.fields.createdDate | string |
Дата создания |
|
Идентификатор поля
|
data.participants.fields.fieldId | string |
Идентификатор поля |
|
Страница No
|
data.participants.fields.pageNo | integer |
Страница No |
|
Идентификатор документа
|
data.participants.fields.documentId | string |
Идентификатор документа |
|
Ширина поля
|
data.participants.fields.width | float |
Ширина поля |
|
Высота поля
|
data.participants.fields.height | float |
Высота поля |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Ценность
|
data.participants.fields.value | string |
Ценность |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Отображаемая метка
|
data.participants.fields.displayLabel | string |
Отображаемая метка |
|
Тип ссылки
|
data.participants.fields.linkType | string |
Тип ссылки |
|
Идентификатор радио
|
data.participants.fields.radioId | integer |
Идентификатор радио |
|
Идентификатор группы радио
|
data.participants.fields.radioGroupId | string |
Идентификатор группы радио |
|
Идентификатор флажка
|
data.participants.fields.checkboxId | integer |
Идентификатор флажка |
|
Имя поля
|
data.participants.fields.fieldName | string |
Имя поля |
|
Положение X
|
data.participants.fields.xposition | float |
Положение поля X |
|
Позиция Y
|
data.participants.fields.yposition | float |
Положение поля Y |
|
Требуется ли?
|
data.participants.fields.required | boolean |
Это обязательное поле? |
|
Только чтение?
|
data.participants.fields.readOnly | boolean |
Это поле "Только для чтения"? |
|
Область текста
|
data.participants.fields.textarea | boolean |
Область текста |
|
Вертикальный
|
data.participants.fields.vertical | boolean |
Вертикальный |
|
Верхний нижний
|
data.participants.fields.topBottom | boolean |
Верхний нижний |
|
Значение по умолчанию
|
data.participants.fields.defaultValue | string |
Значение по умолчанию |
|
Формат
|
data.participants.signatureBlock.format | array of object |
Формат |
|
Идентификатор
|
data.participants.signatureBlock.format.id | string |
Идентификатор |
|
Последовательность
|
data.participants.signatureBlock.format.sequence | integer |
Последовательность |
|
Требуется ли?
|
data.participants.signatureBlock.format.required | boolean |
Требуется ли? |
|
По умолчанию
|
data.participants.signatureBlock.default | boolean |
По умолчанию |
|
Включение делегата
|
data.participants.enableDelegate | boolean |
Включение делегата |
|
Автопроцесс
|
data.participants.autoProcess | boolean |
Автопроцесс |
|
Пользователи CC
|
data.ccUsers | array of object |
Пользователи CC |
|
Имя
|
data.ccUsers.name | string |
Имя |
|
Электронная почта
|
data.ccUsers.emailAddress | string |
Электронная почта |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Идентификатор документа
|
data.documents.id | string |
Идентификатор документа |
|
Последовательность
|
data.documents.sequence | integer |
Последовательность |
|
Имя файла
|
data.documents.fileName | string |
Имя файла |
|
Число страниц
|
data.documents.pageCount | integer |
Число страниц |
|
Является ли делетируемым?
|
data.documents.deletable | boolean |
Является ли делетируемым? |
|
Является частным
|
data.documents.private | boolean |
Является частным |
|
Настраиваемые поля
|
data.customFields | array of object |
Настраиваемые поля |
|
Идентификатор настраиваемого поля
|
data.customFields.customFieldId | string |
Идентификатор настраиваемого поля |
|
Значение поля
|
data.customFields.value | string |
Значение поля |
|
Имя поля
|
data.customFields.fieldName | string |
Имя поля |
|
Тип поля
|
data.customFields.fieldType | string |
Тип поля |
|
Подписки на уведомления
|
data.notificationSubscriptions | array of |
Подписки на уведомления |
|
tags
|
data.tags | array of |
tags |
|
Дополнительные документы
|
data.additionalDocuments | array of object |
Дополнительные документы |
|
Идентификатор
|
data.additionalDocuments.id | string |
Идентификатор |
|
Имя файла
|
data.additionalDocuments.fileName | string |
Имя файла |
|
Тип
|
data.additionalDocuments.type | string |
Тип |
|
Идентификатор кандидата
|
data.additionalDocuments.candidateId | string |
Идентификатор кандидата |
|
Отдельные соглашения
|
data.separateAgreements | boolean |
Отдельные соглашения |
Скачивание документов для транзакции
Скачивание документов для заданного идентификатора транзакции
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
ИД транзакции
|
transactionId | True | string |
Уникальный идентификатор транзакции |
|
Тип документа
|
documentType | True | string |
Тип документа для скачивания |
Возвращаемое значение
- response
- file
Создание пользователя
Создание пользователя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Электронная почта
|
emailAddress | string |
Электронная почта |
|
|
Имя (Первое имя)
|
firstName | string |
Имя (Первое имя) |
|
|
Фамилия
|
lastName | string |
Фамилия |
|
|
Компания
|
company | string |
Компания |
|
|
Часовой пояс
|
timezone | string |
Часовой пояс |
|
|
Language
|
language | string |
Language |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Salutation
|
salutation | string |
Salutation |
|
|
Должность
|
jobTitle | string |
Должность |
|
|
Номер телефона
|
phoneNumber | string |
Номер телефона |
|
|
Код страны
|
phoneCountryCode | string |
Код страны |
|
|
Роли
|
roles | array of string |
Роли |
|
|
Отключена ли окончательная почта?
|
finalMailDisabled | boolean |
Отключена ли окончательная почта? |
|
|
Отключена ли почта напоминания?
|
reminderMailDisabled | boolean |
Отключена ли почта напоминания? |
|
|
Отключена ли почта отправителя?
|
senderMailDisabled | boolean |
Отключена ли почта отправителя? |
|
|
Пользователь интеграции?
|
integrationUser | boolean |
Пользователь интеграции? |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
Идентификатор пользователя
|
data.user_id | string |
Идентификатор пользователя |
Создание транзакции
Создание транзакции
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя транзакции
|
name | True | string |
Имя транзакции |
|
Message
|
message | string |
Сообщение для всех участников электронной почты. |
|
|
URL-адрес обратного вызова
|
url | string |
URL-адрес обратного вызова |
|
|
События транзакций
|
transactionEvents | array of string |
События транзакций |
|
|
События участников
|
participantEvents | array of string |
События участников |
|
|
Состояние транзакции
|
status | string |
Состояние транзакции |
|
|
Внешний идентификатор
|
externalId | string |
Внешний идентификатор |
|
|
Срок действия метки времени
|
expiresAtTimestamp | string |
Срок действия транзакции истекает в метку времени |
|
|
Напоминание из метки времени
|
remindFromTimestamp | string |
Напоминание из метки времени |
|
|
Частота напоминаний
|
reminderFrequency | integer |
Частота напоминания |
|
|
Поля по умолчанию
|
default | boolean |
Поля блоков подписей по умолчанию |
|
|
Последовательность участника
|
sequence | integer |
Последовательность |
|
|
Role
|
role | string |
Role |
|
|
Имя
|
name | string |
Имя кандидата |
|
|
Электронная почта
|
emailAddress | string |
Адрес электронной почты кандидата |
|
|
Language
|
language | string |
Language |
|
|
Режим проверки подлинности
|
authenticationMode | string |
Режим проверки подлинности |
|
|
Значение режима проверки подлинности
|
authenticationModeValue | string |
Значение режима проверки подлинности |
|
|
Каналы доставки
|
deliveryChannels | array of string |
Каналы доставки |
|
|
Идентификатор поля
|
fieldId | string |
Идентификатор поля |
|
|
Страницы
|
pages | array of string |
Страницы |
|
|
Идентификатор документа
|
documentId | string |
Идентификатор документа |
|
|
Ширина поля
|
width | float |
Ширина поля |
|
|
Высота поля
|
height | float |
Высота поля |
|
|
Tooltip
|
tooltip | string |
Tooltip |
|
|
DateFormat
|
dateFormat | string |
DateFormat |
|
|
Число строк текстовой области
|
textareaLineCount | string |
Число строк текстовой области |
|
|
Имя поля
|
fieldName | string |
Имя поля |
|
|
Положение X
|
xposition | float |
Положение поля X |
|
|
Позиция Y
|
yposition | float |
Положение поля Y |
|
|
Требуется ли?
|
required | boolean |
Это обязательное поле? |
|
|
Только чтение?
|
readOnly | boolean |
Это поле "Только для чтения"? |
|
|
Область текста
|
textarea | boolean |
Область текста |
|
|
Верхний нижний
|
topBottom | boolean |
Верхний нижний |
|
|
Вертикальный
|
vertical | boolean |
Вертикальный |
|
|
Идентификатор группы радио
|
radioGroupId | string |
Идентификатор группы радио |
|
|
Значение по умолчанию
|
defaultValue | string |
Значение по умолчанию |
|
|
Ценность
|
value | string |
Ценность |
|
|
Отображаемая метка
|
displayLabel | string |
Отображаемая метка |
|
|
Имя
|
name | string |
Имя |
|
|
Электронная почта
|
emailAddress | string |
Электронная почта |
|
|
Language
|
language | string |
Language |
|
|
Идентификатор документа
|
id | string |
Идентификатор документа |
|
|
Последовательность
|
sequence | integer |
Последовательность |
|
|
Является ли делетируемым?
|
deletable | boolean |
Является ли делетируемым? |
|
|
Является частным
|
private | boolean |
Является частным |
|
|
Значение поля
|
value | string |
Значение поля |
|
|
Имя поля
|
fieldName | string |
Имя поля |
|
|
Code
|
code | string |
Code |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
ИД транзакции
|
data.transactionId | string |
ИД транзакции |
Создание транзакции с помощью шаблона
Создание транзакции с помощью заданного идентификатора шаблона
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Имя транзакции
|
name | string |
Имя транзакции |
|
|
Состояние транзакции
|
status | string |
Состояние транзакции |
|
|
Внешний идентификатор
|
externalId | string |
Внешний идентификатор |
|
|
Идентификатор шаблона
|
templateId | string |
Идентификатор шаблона |
|
|
Идентификаторы вторичных шаблонов
|
secondaryTemplateIds | array of string |
Идентификаторы вторичных шаблонов |
|
|
Message
|
message | string |
Сообщение для всех участников электронной почты. |
|
|
URL-адрес обратного вызова
|
url | string |
URL-адрес обратного вызова |
|
|
События транзакций
|
transactionEvents | array of string |
События транзакций |
|
|
События участников
|
participantEvents | array of string |
События участников |
|
|
Последовательность участника
|
sequence | integer |
Последовательность |
|
|
Role
|
role | string |
Role |
|
|
Автопроцесс?
|
autoProcess | boolean |
Автопроцесс? |
|
|
Имя поля
|
fieldName | string |
Имя поля |
|
|
Значение поля
|
value | string |
Значение поля |
|
|
Имя
|
name | string |
Имя кандидата |
|
|
Электронная почта
|
emailAddress | string |
Адрес электронной почты кандидата |
|
|
Message
|
message | string |
Message |
|
|
Language
|
language | string |
Language |
|
|
Каналы доставки
|
deliveryChannels | array of string |
Каналы доставки |
|
|
Настраиваемый текст SMS
|
customSMSBody | string |
Настраиваемый текст SMS |
|
|
Имя
|
name | string |
Имя |
|
|
Message
|
message | string |
Message |
|
|
Требуется ли?
|
required | boolean |
Требуется ли? |
|
|
Имя
|
name | string |
Имя |
|
|
Электронная почта
|
emailAddress | string |
Электронная почта |
|
|
Language
|
language | string |
Language |
|
|
Значение поля
|
value | string |
Значение поля |
|
|
Имя поля
|
fieldName | string |
Имя поля |
|
|
Code
|
code | string |
Code |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
ИД транзакции
|
data.transactionId | string |
ИД транзакции |
Список пользователей
Список пользователей
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Номер страницы
|
pageNo | True | integer | |
|
Записей на странице
|
perPageRecords | True | integer |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
Всего записей
|
data.totalRecords | integer |
общий объем записей |
|
Всего страниц
|
data.totalPages | integer |
Всего страниц |
|
Записи страниц
|
data.perPageRecords | integer |
Записи страниц |
|
Номер страницы
|
data.pageNo | integer |
Номер страницы |
|
Записи
|
data.records | array of object |
Записи пользователей |
|
Имя (Первое имя)
|
data.records.firstName | string |
Имя (Первое имя) |
|
Фамилия
|
data.records.lastName | string |
Фамилия |
|
Компания
|
data.records.company | string |
Компания |
|
Часовой пояс
|
data.records.timezone | string |
Часовой пояс |
|
Language
|
data.records.language | string |
Language |
|
DateFormat
|
data.records.dateFormat | string |
DateFormat |
|
Должность
|
data.records.jobTitle | string |
Должность |
|
Номер телефона
|
data.records.phoneNumber | string |
Номер телефона |
|
Код страны
|
data.records.phoneCountryCode | string |
Код страны |
|
Роли
|
data.records.roles | array of string |
Роли |
|
Отключена ли окончательная почта?
|
data.records.finalMailDisabled | boolean |
Отключена ли окончательная почта? |
|
Отключена ли почта напоминания?
|
data.records.reminderMailDisabled | boolean |
Отключена ли почта напоминания? |
|
Отключена ли почта отправителя?
|
data.records.senderMailDisabled | boolean |
Отключена ли почта отправителя? |
|
Пользователь интеграции?
|
data.records.integrationUser | boolean |
Пользователь интеграции? |
|
Salutation
|
data.records.salutation | string |
Salutation |
|
Активен
|
data.records.active | boolean |
Активен |
|
Идентификатор
|
data.records.id | string |
Идентификатор |
|
Электронная почта
|
data.records.emailAddress | string |
Электронная почта |
Удалить подписку
Удалить подписку
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор веб-перехватчика
|
webhookId | True | string |
Уникальный идентификатор подписки веб-перехватчика для удаления |
Триггеры
| Изменение состояния транзакции |
Регистрация обратного вызова для определенного события транзакции |
Изменение состояния транзакции
Регистрация обратного вызова для определенного события транзакции
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Тип события
|
eventType | True | array |
Тип события транзакции для регистрации |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Отметка времени
|
timestamp | integer |
Отметка времени |
|
Код состояния
|
statusCode | integer |
Код состояния |
|
Message
|
message | string |
Message |
|
Имя транзакции
|
data.name | string |
Имя транзакции |
|
Состояние транзакции
|
data.status | string |
Состояние транзакции |
|
ИД транзакции
|
data.transactionId | string |
ИД транзакции |
|
Message
|
data.mail.message | string |
Сообщение для всех участников электронной почты. |
|
Дата последнего обновления
|
data.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.createdDate | string |
Дата создания |
|
Идентификатор пользователя
|
data.createdBy.id | string |
Создан идентификатором пользователя |
|
Имя пользователя
|
data.createdBy.username | string |
Создано с помощью имени пользователя |
|
Электронная почта
|
data.createdBy.emailAddress | string |
Создан по адресу электронной почты |
|
Дата отправки
|
data.sentDate | string |
Дата отправки |
|
Идентификатор пользователя
|
data.lastActionPerformedBy.userId | string |
Идентификатор пользователя |
|
Имя пользователя
|
data.lastActionPerformedBy.userName | string |
Имя пользователя |
|
Электронная почта
|
data.lastActionPerformedBy.emailAddress | string |
Электронная почта |
|
Идентификатор кандидата
|
data.lastActionPerformedBy.candidateId | string |
Идентификатор кандидата |
|
Идентификатор участника
|
data.lastActionPerformedBy.participantId | string |
Идентификатор участника |
|
Срок действия метки времени
|
data.expiryAndReminders.expiresAtTimestamp | string |
Срок действия транзакции истекает в метку времени |
|
Срок действия дней
|
data.expiryAndReminders.expiryDays | integer |
Срок действия дней |
|
Напоминание из дней напоминания
|
data.expiryAndReminders.remindFromReminderDays | integer |
Напоминание из дней напоминания |
|
Напоминание из времени напоминания
|
data.expiryAndReminders.remindFromReminderTime | string |
Напоминание из времени напоминания |
|
Частота напоминаний
|
data.expiryAndReminders.reminderFrequency | integer |
Частота напоминания |
|
Участники
|
data.participants | array of object |
Участники |
|
Идентификатор участника
|
data.participants.id | string |
Идентификатор участника |
|
Состояние участника
|
data.participants.status | string |
Состояние участника |
|
Дата последнего обновления
|
data.participants.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.participants.createdDate | string |
Дата создания |
|
Последовательность участника
|
data.participants.sequence | integer |
Последовательность |
|
Role
|
data.participants.role | string |
Role |
|
Метод подписи
|
data.participants.signingMethodDTO | array of string |
Сведения о методе подписывания |
|
Отправлено пользователем
|
data.participants.submittedBys | array of object |
Отправлены сведениями пользователя |
|
Идентификатор пользователя
|
data.participants.submittedBys.userId | string |
Отправлен идентификатором пользователя |
|
Имя пользователя
|
data.participants.submittedBys.userName | string |
Отправлено именем пользователя |
|
Электронная почта
|
data.participants.submittedBys.emailAddress | string |
Отправлен по адресу электронной почты пользователя |
|
Идентификатор кандидата
|
data.participants.submittedBys.candidateId | string |
Идентификатор кандидата |
|
Кандидатов
|
data.participants.candidates | array of object |
Кандидатов |
|
Идентификатор кандидата
|
data.participants.candidates.id | string |
Идентификатор кандидата |
|
Имя
|
data.participants.candidates.name | string |
Имя кандидата |
|
Электронная почта
|
data.participants.candidates.emailAddress | string |
Адрес электронной почты кандидата |
|
Language
|
data.participants.candidates.language | string |
Language |
|
Тип
|
data.participants.candidates.type | string |
Тип |
|
Действие
|
data.participants.candidates.action | string |
Действие |
|
Дата действия
|
data.participants.candidates.actionDate | string |
Дата действия |
|
Дата создания
|
data.participants.candidates.createdDate | string |
Дата создания |
|
Значение режима проверки подлинности
|
data.participants.candidates.authenticationInfo.authenticationModeValue | string |
Значение режима проверки подлинности |
|
Сведения о методе подписывания
|
data.participants.candidates.signingMethodDTO | array of string |
Сведения о методе подписывания |
|
Attachments
|
data.participants.candidates.attachments | array of |
Attachments |
|
Каналы доставки
|
data.participants.candidates.deliveryChannels | array of string |
Каналы доставки |
|
Fields
|
data.participants.fields | array of object |
Fields |
|
Идентификатор
|
data.participants.fields.id | string |
Идентификатор |
|
Дата последнего обновления
|
data.participants.fields.lastUpdatedDate | string |
Дата последнего обновления |
|
Дата создания
|
data.participants.fields.createdDate | string |
Дата создания |
|
Идентификатор поля
|
data.participants.fields.fieldId | string |
Идентификатор поля |
|
Страница No
|
data.participants.fields.pageNo | integer |
Страница No |
|
Идентификатор документа
|
data.participants.fields.documentId | string |
Идентификатор документа |
|
Ширина поля
|
data.participants.fields.width | float |
Ширина поля |
|
Высота поля
|
data.participants.fields.height | float |
Высота поля |
|
Tooltip
|
data.participants.fields.tooltip | string |
Tooltip |
|
Ценность
|
data.participants.fields.value | string |
Ценность |
|
Validation
|
data.participants.fields.validation | string |
Validation |
|
NameStyle
|
data.participants.fields.nameStyle | string |
NameStyle |
|
DateFormat
|
data.participants.fields.dateFormat | string |
DateFormat |
|
Отображаемая метка
|
data.participants.fields.displayLabel | string |
Отображаемая метка |
|
Тип ссылки
|
data.participants.fields.linkType | string |
Тип ссылки |
|
Идентификатор радио
|
data.participants.fields.radioId | integer |
Идентификатор радио |
|
Идентификатор группы радио
|
data.participants.fields.radioGroupId | string |
Идентификатор группы радио |
|
Идентификатор флажка
|
data.participants.fields.checkboxId | integer |
Идентификатор флажка |
|
Имя поля
|
data.participants.fields.fieldName | string |
Имя поля |
|
Положение X
|
data.participants.fields.xposition | float |
Положение поля X |
|
Позиция Y
|
data.participants.fields.yposition | float |
Положение поля Y |
|
Требуется ли?
|
data.participants.fields.required | boolean |
Это обязательное поле? |
|
Только чтение?
|
data.participants.fields.readOnly | boolean |
Это поле "Только для чтения"? |
|
Область текста
|
data.participants.fields.textarea | boolean |
Область текста |
|
Вертикальный
|
data.participants.fields.vertical | boolean |
Вертикальный |
|
Верхний нижний
|
data.participants.fields.topBottom | boolean |
Верхний нижний |
|
Значение по умолчанию
|
data.participants.fields.defaultValue | string |
Значение по умолчанию |
|
Формат
|
data.participants.signatureBlock.format | array of object |
Формат |
|
Идентификатор
|
data.participants.signatureBlock.format.id | string |
Идентификатор |
|
Последовательность
|
data.participants.signatureBlock.format.sequence | integer |
Последовательность |
|
Требуется ли?
|
data.participants.signatureBlock.format.required | boolean |
Требуется ли? |
|
По умолчанию
|
data.participants.signatureBlock.default | boolean |
По умолчанию |
|
Включение делегата
|
data.participants.enableDelegate | boolean |
Включение делегата |
|
Автопроцесс
|
data.participants.autoProcess | boolean |
Автопроцесс |
|
Пользователи CC
|
data.ccUsers | array of object |
Пользователи CC |
|
Имя
|
data.ccUsers.name | string |
Имя |
|
Электронная почта
|
data.ccUsers.emailAddress | string |
Электронная почта |
|
Language
|
data.ccUsers.language | string |
Language |
|
Documents
|
data.documents | array of object |
Documents |
|
Идентификатор документа
|
data.documents.id | string |
Идентификатор документа |
|
Последовательность
|
data.documents.sequence | integer |
Последовательность |
|
Имя файла
|
data.documents.fileName | string |
Имя файла |
|
Число страниц
|
data.documents.pageCount | integer |
Число страниц |
|
Является ли делетируемым?
|
data.documents.deletable | boolean |
Является ли делетируемым? |
|
Является частным
|
data.documents.private | boolean |
Является частным |
|
Настраиваемые поля
|
data.customFields | array of object |
Настраиваемые поля |
|
Идентификатор настраиваемого поля
|
data.customFields.customFieldId | string |
Идентификатор настраиваемого поля |
|
Значение поля
|
data.customFields.value | string |
Значение поля |
|
Имя поля
|
data.customFields.fieldName | string |
Имя поля |
|
Тип поля
|
data.customFields.fieldType | string |
Тип поля |
|
Подписки на уведомления
|
data.notificationSubscriptions | array of |
Подписки на уведомления |
|
tags
|
data.tags | array of |
tags |
|
Дополнительные документы
|
data.additionalDocuments | array of object |
Дополнительные документы |
|
Идентификатор
|
data.additionalDocuments.id | string |
Идентификатор |
|
Имя файла
|
data.additionalDocuments.fileName | string |
Имя файла |
|
Тип
|
data.additionalDocuments.type | string |
Тип |
|
Идентификатор кандидата
|
data.additionalDocuments.candidateId | string |
Идентификатор кандидата |
|
Отдельные соглашения
|
data.separateAgreements | boolean |
Отдельные соглашения |
Определения
file
Это базовый тип данных file.