Box Sign
Создание, управление и отслеживание запросов на электронную подпись с Box Sign
Интеграция с Box Sign для создания и управления запросами на электронную подпись. Отправка документов на подпись, отслеживание статуса, добавление нескольких подписантов, установка срока действия, включение напоминаний, повторная отправка и отмена запросов.
Создание нового запроса на электронную подпись через Box Sign.
| Параметр | Тип | Обязательный | Описание |
|---|
sourceFileIds | string | Да | ID исходных файлов для подписи |
signerEmail | string | Да | Email подписанта |
signerRole | string | Нет | Роль подписанта |
additionalSigners | string | Нет | JSON-массив дополнительных подписантов |
parentFolderId | string | Нет | ID родительской папки |
emailSubject | string | Нет | Тема email-уведомления |
emailMessage | string | Нет | Текст email-уведомления |
name | string | Нет | Название запроса |
daysValid | number | Нет | Срок действия в днях |
areRemindersEnabled | boolean | Нет | Включить напоминания |
areTextSignaturesEnabled | boolean | Нет | Включить текстовые подписи |
signatureColor | string | Нет | Цвет подписи |
redirectUrl | string | Нет | URL перенаправления после подписания |
declinedRedirectUrl | string | Нет | URL при отказе от подписания |
isDocumentPreparationNeeded | boolean | Нет | Требуется подготовка документа |
externalId | string | Нет | Внешний ID |
| Параметр | Тип | Описание |
|---|
id | string | ID запроса на подпись |
status | string | Статус запроса (converting, created, sent, viewed, signed, cancelled, declined, expired, error_converting, error_sending, finalizing, error_finalizing) |
name | string | Название запроса |
shortId | string | Короткий читаемый ID |
signers | array | Список подписантов |
sourceFiles | array | Исходные файлы |
emailSubject | string | Тема письма |
emailMessage | string | Текст письма |
daysValid | number | Срок действия в днях |
createdAt | string | Дата создания |
autoExpireAt | string | Дата авто-истечения |
prepareUrl | string | URL для подготовки документа |
senderEmail | string | Email отправителя |
Получение информации о запросе на подпись по его ID.
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись |
| Параметр | Тип | Описание |
|---|
id | string | ID запроса |
status | string | Статус запроса |
name | string | Название запроса |
shortId | string | Короткий ID |
signers | array | Список подписантов |
sourceFiles | array | Исходные файлы |
emailSubject | string | Тема письма |
emailMessage | string | Текст письма |
daysValid | number | Срок действия |
createdAt | string | Дата создания |
autoExpireAt | string | Дата истечения |
prepareUrl | string | URL подготовки |
senderEmail | string | Email отправителя |
Получение списка всех запросов на подпись с пагинацией.
| Параметр | Тип | Обязательный | Описание |
|---|
limit | number | Нет | Количество результатов |
marker | string | Нет | Маркер для пагинации |
| Параметр | Тип | Описание |
|---|
signRequests | array | Список запросов на подпись |
↳ id | string | ID запроса |
↳ status | string | Статус |
↳ name | string | Название |
↳ shortId | string | Короткий ID |
↳ signers | array | Подписанты |
↳ sourceFiles | array | Файлы |
↳ emailSubject | string | Тема |
↳ emailMessage | string | Текст |
↳ daysValid | number | Срок действия |
↳ createdAt | string | Дата создания |
↳ autoExpireAt | string | Дата истечения |
↳ prepareUrl | string | URL подготовки |
↳ senderEmail | string | Email отправителя |
count | number | Количество запросов на странице |
nextMarker | string | Маркер следующей страницы |
Отмена запроса на подпись по его ID.
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись |
| Параметр | Тип | Описание |
|---|
id | string | ID запроса |
status | string | Статус запроса |
name | string | Название |
shortId | string | Короткий ID |
signers | array | Подписанты |
sourceFiles | array | Файлы |
emailSubject | string | Тема |
emailMessage | string | Текст |
daysValid | number | Срок действия |
createdAt | string | Дата создания |
autoExpireAt | string | Дата истечения |
prepareUrl | string | URL подготовки |
senderEmail | string | Email отправителя |
Повторная отправка запроса на подпись.
| Параметр | Тип | Обязательный | Описание |
|---|
signRequestId | string | Да | ID запроса на подпись |
| Параметр | Тип | Описание |
|---|
message | string | Сообщение о подтверждении успешной отправки |
