BoldSign (предварительная версия)
BoldSign — это безопасное, простое решение электронной подписи, которое предоставляет юридически обязательные способы отправки, подписывания и управления документами.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | 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) |
| Контакт | |
|---|---|
| Имя | Поддержка BoldSign |
| URL | https://support.boldsign.com |
| Адрес электронной почты | support@boldsign.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Syncfusion-Inc |
| Веб-сайт | https://boldsign.com/ |
| Категории | Содержимое и файлы; Продуктивность |
| Политика конфиденциальности | https://boldsign.com/privacy-policy/ |
BoldSign — это онлайн-приложение сигнатуры, и соединитель BoldSign охватывает следующие сценарии.
- Пользователь может прослушивать триггер и отправлять документ для подписывания на основе сведений из триггера.
- Пользователь может прослушивать завершенное событие документа и скачать подписанный PDF-документ, чтобы сохранить его в предпочтительном облачном хранилище или любом действии, которое они предпочитают.
- Пользователь может отслеживать состояние документа или получать состояние документа и выполнять действия, основанные на нем, например отправлять напоминания по электронной почте или SMS через другую службу или соединитель.
- Пользователь может прослушивать несколько событий, таких как отправка, сбой проверки подлинности, отклонение, срок действия и т. д. для выполнения действий на основе сведений, предоставленных с помощью триггера события.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| Выбор региона | струна | Выберите региональный центр обработки данных BoldSign, где находится учетная запись |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Отправка документа с помощью шаблона с получателем |
Отправьте документ для подписи с помощью указанного шаблона получателю. |
| Получение состояния документа |
Извлекает состояние документа и его сведения о документе. |
|
Скачать Audit |
Скачайте путь аудита завершенного документа. |
| Скачивание документа |
Загружает PDF-файл заданного идентификатора документа. |
Отправка документа с помощью шаблона с получателем
Отправьте документ для подписи с помощью указанного шаблона получателю.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Template
|
templateId | True | string |
Выбор шаблона |
|
Режим песочницы
|
isSandbox | True | boolean |
При включении BoldSign отправляет запросы подписи в режиме песочницы, что позволяет протестировать интеграцию. |
|
Название документа
|
title | True | string |
Введите название документа |
|
Описание документа
|
message | string |
Введите описание документа |
|
|
КРЕДИТНАЯ КАРТА
|
cc | string |
Введите один или несколько адресов электронной почты, разделенных запятыми |
|
|
Бренд
|
brandId | string |
Выбор бренда |
|
|
От имени
|
onBehalfOf | string |
Выберите адрес электронной почты для отправки от имени другого пользователя |
|
|
Срок действия дней
|
expiryDays | integer |
Укажите количество дней, после которых истекает срок действия документа. |
|
|
Метки документов
|
labels | string |
Укажите одну или несколько меток для документа, разделенные запятыми |
|
|
Скрытие идентификатора документа
|
hideDocumentId | boolean |
При включении отпечаток идентификатора будет скрыт в верхней части документа. |
|
|
Разрешить печать и знак
|
enablePrintAndSign | boolean |
Когда разрешено, подписыватель сможет распечатать и подписать документ. |
|
|
Разрешить переназначение
|
enableReassign | boolean |
Если разрешено, подписыватель сможет переназначить документ другим пользователям. |
|
|
Включение автоматического напоминания
|
enableAutoReminder | boolean |
При включении BoldSign отправляет автоматические сообщения электронной почты напоминания по указанной частоте. |
|
|
Подписыватели
|
signers | True | dynamic |
Подписыватели документа. |
Возвращаемое значение
Объект ответа запроса на отправку документа шаблона.
Получение состояния документа
Извлекает состояние документа и его сведения о документе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Укажите идентификатор документа |
Возвращаемое значение
Объект ответа запроса свойств документа.
Скачать AuditTrail
Скачайте путь аудита завершенного документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Укажите идентификатор документа |
|
От имени
|
onBehalfOf | string |
Выберите адрес электронной почты для выполнения действия от имени другого пользователя |
Скачивание документа
Загружает PDF-файл заданного идентификатора документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
documentId | True | string |
Укажите идентификатор документа |
|
От имени
|
onBehalfOf | string |
Выберите адрес электронной почты для выполнения действия от имени другого пользователя |
Триггеры
| События веб-перехватчика |
Это активирует событие веб-перехватчика документов. |
События веб-перехватчика
Это активирует событие веб-перехватчика документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Выбор событий веб-перехватчика
|
events | True | string |
Выберите событие веб-перехватчика, для которого должен быть активирован поток. |
|
События пользователя группы
|
adminMode | True | boolean |
Включите этот параметр для получения уведомлений о событиях, активированных участниками команды. Администраторы учетных записей также получат уведомления о событиях во всей организации. При отключении вы получите уведомления только для собственных событий. |
Возвращаемое значение
Данные событий webhooks.
- Тело
- WebHookEventOject
Определения
SendDocumentFromTemplateResponse
Объект ответа запроса на отправку документа шаблона.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор документа
|
documentId | string |
Идентификатор созданного документа. |
DocumentPropertiesResponse
Объект ответа запроса свойств документа.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Состояние документа
|
status | string |
Состояние и другие сведения о документе |
WebHookEventOject
Данные событий webhooks.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор события
|
event.id | string |
Идентификатор события |
|
Создано
|
event.created | integer |
Событие, созданное даты |
|
Тип события
|
event.eventType | string |
Тип события |
|
Идентификатор клиента
|
event.clientId | string |
Идентификатор клиента |
|
Окружающая среда
|
event.environment | string |
Тип среды |
|
Object
|
data.object | string |
Тип объекта |
|
Идентификатор документа
|
data.documentId | string |
Идентификатор документа |
|
Название документа
|
data.messageTitle | string |
Название документа |
|
Описание документа
|
data.documentDescription | string |
Описание документа |
|
Состояние документа
|
data.status | string |
Состояние документа |
|
Имя отправителя
|
data.senderDetail.name | string |
Имя отправителя |
|
Электронная почта отправителя
|
data.senderDetail.emailAddress | string |
Адрес электронной почты отправителя |
|
signerDetails
|
data.signerDetails | array of object |
Сведения о подписывшем |
|
Имя подписи
|
data.signerDetails.signerName | string |
Имя подписывющего элемента |
|
Роль подписывчика
|
data.signerDetails.signerRole | string |
Роль подписи |
|
Электронная почта подписывющего средства
|
data.signerDetails.signerEmail | string |
Сообщение электронной почты для подписывателя |
|
Код страны
|
data.signerDetails.phoneNumber.countryCode | string |
Код страны |
|
Номер телефона
|
data.signerDetails.phoneNumber.number | string |
Номер телефона |
|
Состояние подписи
|
data.signerDetails.status | string |
Состояние подписывателя |
|
Код доступа с поддержкой
|
data.signerDetails.enableAccessCode | boolean |
Указывает, включен ли код доступа или нет |
|
Сбой проверки подлинности
|
data.signerDetails.isAuthenticationFailed | string |
Указывает, завершилось ли проверка подлинности ошибкой или нет |
|
Включенная электронная почта OTP
|
data.signerDetails.enableEmailOTP | boolean |
Указывает, включена ли функция OTP электронной почты |
|
Сбой доставки
|
data.signerDetails.isDeliveryFailed | boolean |
Указывает, не удалось ли доставка документов или нет |
|
Просмотрено
|
data.signerDetails.isViewed | boolean |
Указывает, просматривается ли документ или нет |
|
Порядок подписывания
|
data.signerDetails.order | integer |
Порядок подписывания |
|
Тип подписывателя
|
data.signerDetails.signerType | string |
Тип подписыватель |
|
Переназначить
|
data.signerDetails.isReassigned | boolean |
Указывает, переназначен ли подписыватель или нет |
|
Переназначение сообщения
|
data.signerDetails.reassignMessage | string |
Сообщение переназначение |
|
Отклонение сообщения
|
data.signerDetails.declineMessage | string |
Сообщение об отклонении |
|
Last Activity Date (Дата последнего действия);
|
data.signerDetails.lastActivityDate | integer |
Дата последнего действия |
|
Тип проверки подлинности
|
data.signerDetails.authenticationType | string |
Тип проверки подлинности |
|
Тип проверки подлинности
|
data.signerDetails.idVerification.type | string |
Тип проверки подлинности |
|
Максимальное число повторных попыток
|
data.signerDetails.idVerification.maximumRetryCount | integer |
Максимальное число повторных попыток |
|
Состояние проверки подлинности
|
data.signerDetails.idVerification.status | string |
Состояние проверки личности |
|
Сопоставление имен
|
data.signerDetails.idVerification.nameMatcher | string |
Тип сопоставления имен |
|
Обязательный динамический захват
|
data.signerDetails.idVerification.requireLiveCapture | boolean |
Указывает, требуется ли запись в реальном времени |
|
Обязательное сопоставление селфи
|
data.signerDetails.idVerification.requireMatchingSelfie | boolean |
Указывает, требуется ли сопоставление селфи или нет |
|
Разрешенная конфигурация поля
|
data.signerDetails.allowFieldConfiguration | boolean |
Указывает, требуется ли настройка поля |
|
Почтовые письма CC
|
data.ccDetails | array of |
Адреса электронной почты cc |
|
От имени
|
data.onBehalfOf | string |
От имени электронной почты |
|
Дата создания
|
data.createdDate | integer |
Дата создания документа |
|
Дата окончания срока действия
|
data.expiryDate | integer |
Дата окончания срока действия документа |
|
Заказ на подписывание с включенной поддержкой
|
data.enableSigningOrder | boolean |
Указывает, включен ли порядок подписывания или нет |
|
Отключенные сообщения электронной почты
|
data.disableEmails | boolean |
Указывает, отключены ли сообщения электронной почты или нет |
|
Отзыв сообщения
|
data.revokeMessage | string |
Сообщение об отзыве |
|
Сообщение об ошибке
|
data.errorMessage | string |
Сообщение об ошибке |
|
Наклейки
|
data.labels | array of |
Метки документов |
|
Объединенный аудит
|
data.isCombinedAudit | boolean |
Указывает, сочетается ли путь аудита с документом или нет |