SignRequest (предварительная версия)

SignRequest — это безопасное и юридическое средство подписи электронной подписи, которое позволяет вам и вашим партнерам подписывать контракты и другие документы быстро и без необходимости печати, подписывания и сканирования.

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

Услуга	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)

Контакт
Адрес электронной почты	tech-support@signrequest.com

Метаданные соединителя
Publisher	SignRequest B.V.

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

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

Действия

Отправка SignRequest

Создает и отправляет новый signRequest.

Отправка SignRequest

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

SignrequestQuickCreateCreate

Создает и отправляет новый signRequest.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Автоматическое удаление дней	auto_delete_days		integer	Число дней, после которого завершенный документ (подписанный или отмененный или отклоненный) автоматически удаляется
Автоматическое истечение срока действия дней	auto_expire_days		integer	Число дней, после которого истекает срок действия незавершенного документа
Отключение вложений	disable_attachments		boolean	Отключение отправки и добавления вложений
Отключение проверки блокчейна	disable_blockchain_proof		boolean	Отключает хэши метки времени в интеграции блокчейна.
Отключить дату	disable_date		boolean	Отключение добавления дат
Отключение сообщений электронной почты	disable_emails		boolean	Отключите все сообщения о состоянии SignRequest, а также сообщения электронной почты, содержащие подписанные документы
Отключение текста	disable_text		boolean	Отключение добавления текста
Отключение текстовых подписей	disable_text_signatures		boolean	Отключение использования подписей, созданных путем ввода (текста)
Отключение подписей отправки	disable_upload_signatures		boolean	Отключение использования отправленных подписей (изображений)
Документ	document		uri
URL-адрес обратного вызова событий	events_callback_url		uri	URL-адрес, по которому для получения обратных вызовов событий для этого документа
Внешний идентификатор	external_id		string	Идентификатор, используемый для ссылки на документ во внешней системе
Файл	file		uri	Временный URL-адрес исходного файла истекает через пять минут.
Файл из содержимого	file_from_content		byte	Содержимое документа в кодировке Base64
Файл из имени содержимого	file_from_content_name		string	Имя файла, включая расширение. Обязательный при использовании file_from_content.
Файл из URL-адреса	file_from_url		uri	Общедоступный URL-адрес документа для скачивания с помощью SignRequest
Из электронной почты	from_email		email	Электронная почта пользователя, отправляющего SignRequest (должна быть проверенной электронной почтой)
Имя электронной почты	from_email_name		string	Имя, используемое в заголовке From электронной почты, например. {from_email_name} <no-reply@signrequest.com>
Идентификатор внешнего интерфейса	frontend_id		string	Общий секрет, используемый в сочетании с клиентом SignRequest-js для предоставления пользователю доступа к документу, который не является членом команды документа
Готовится	is_being_prepared		boolean	Предоставитель SignRequest подготовьте документ перед отправкой запроса, см. статью "Подготовка с помощью веб-интерфейса"
Message	message		string	Сообщение, включаемое в электронную почту SignRequest, может содержать следующие html-теги: a, emabbracronymbblockquotecodeiulliolstrong
Имя	name		string	По умолчанию используется имя файла, включая расширение
Флажок "Перед заполнением тегов"	checkbox_value		boolean
Значение даты даты перед заполнением тегов	date_value		date
Внешний идентификатор тегов предварительной заполнения	external_id		string
Текст тегов предварительной заполнения	text		string
Url-адрес подготовки	prepare_url		uri
URL-адрес перенаправления	redirect_url		uri	URL-адрес, на который SignRequest будет перенаправлен при подписании документа
Url-адрес перенаправления отклонен	redirect_url_declined		uri	URL-адрес, по которому SignRequest перенаправляется, когда документ отклоняется
Обязательное имя вложения	name	True	string
Обязательный код вложения Uuid	uuid		string
Отправка напоминаний	send_reminders		boolean	Автоматически напоминать подписывателям подписывать документ, см. статью "Автоматические напоминания"
Подписыватель после документа	after_document		uri
Только подписыватель утверждает	approve_only		boolean	Требовать, чтобы пользователь одобрил документ (без добавления подписи), см. статью "Утвердить только"
Файл	file		uri
Обязательное имя вложения	name	True	string
Обязательный код вложения Uuid	uuid		string
Имя	name		string	По умолчанию используется имя файла
Uuid	uuid		string
Отклонил подписыватель	declined		boolean
Подписыватель отказался	declined_on		date-time
Отображаемое имя подписи	display_name		string
Скачанный подписыватель	downloaded		boolean
Электронная почта подписывющего средства	email	True	email
Просмотр электронной почты подписывателя	email_viewed		boolean
Подписыватель по электронной почте	emailed		boolean
URL-адрес внедрения подписи	embed_url		uri
Идентификатор пользователя url-адреса внедрения signer	embed_url_user_id		string
Имя подписывающего пользователя	first_name		string
Язык принудительного подписывания	force_language		boolean
Подписыватель переадресован	forwarded		boolean
Переадресация подписывателя	forwarded_on		date-time
Причина переадресации подписывющего средства	forwarded_reason		string
Подписыватель пересылается по электронной почте	forwarded_to_email		email
Вход пользователя	in_person		boolean	При использовании в сочетании с URL-адресом внедрения для отправителя после того, как отправитель подписал, они будут перенаправлены на следующий in_person подписыватель, см. статью "Пользователь"
Значение флажка	checkbox_value		boolean
Значение даты	date_value		date
Внешний идентификатор	external_id		string
Индекс страницы	page_index	True	integer
Заполнитель uuid	placeholder_uuid		string
Текст	text		string
Тип	type		string
Язык подписи	language		string
Фамилия подписывющего пользователя	last_name		string
Сообщение о подписывшем	message		string
Подписыватель должен подписаться	needs_to_sign		boolean	Если false пользователю не нужно подписаться, но будет получена копия подписанного документа и журнала подписывания, см. статью "Копировать только"
Только уведомление подписывющего пользователя	notify_only		boolean	Отправка уведомлений о документе и копии подписанного документа и журнала подписывания, но не требует выполнения каких-либо действий, см. в статье "Уведомление только для уведомления".
Порядок подписывания	order		integer
Пароль для подписывания	password		string	Прежде чем подписывать документ, необходимо ввести этот пароль. Это поле только для записи.
URL-адрес перенаправления подписывающего пользователя	redirect_url		uri
Url-адрес перенаправления подписывающего пользователя отклонен	redirect_url_declined		uri
Подписанный подписыватель	signed		boolean
Вход в систему	signed_on		date-time
Подписыватель использует метку только для утверждения	use_stamp_for_approve_only		boolean	Поместите метку утверждения в документ, когда подписыватель утверждает документ
Подписыватель проверяет банковский счет	verify_bank_account		string
Подписыватель проверяет номер телефона	verify_phone_number		string
Просмотр подписыватель	viewed		boolean
Команда	subdomain		string
Тема	subject		string	Тема сообщения электронной почты SignRequest
Template	template		uri
Заблокирована проверка текстового сообщения	text_message_verification_locked		boolean	Если требуется проверка текстового сообщения, прежде чем подписыватель сможет просмотреть документ
URL-адрес	url		uri
Uuid	uuid		string
Кто	who		string	m: только я, mo: я и другие, o: только другие

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

Тело

SignRequestQuickCreate

Триггеры

При изменении состояния документа

Активируется при изменении состояния документа signRequest.

При изменении состояния документа

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

WebhooksCreate

Активируется при изменении состояния документа signRequest.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Создано	created		date-time
Тип события	event_type	True	string
Имя	name		string	Необязательное имя, чтобы легко определить, для какого веб-перехватчика используется
Команда	subdomain		string
Имя группы	name		string
Поддомен команды	subdomain		uri
URL-адрес группы	url		uri
URL-адрес	url		uri
Uuid	uuid		string

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

Имя	Путь	Тип	Описание
документ	document	Document

Определения

Документ

Имя	Путь	Тип	Описание
Используемый API документов	api_used	boolean	Указывает, был ли документ создан с помощью API
attachments	attachments	array of DocumentAttachment
Автоматическое удаление документа после	auto_delete_after	date-time	Дата и время, вычисляемые с помощью auto_delete_days которого завершенный документ (подписанный или отмененный или отклоненный) автоматически удаляются.
Дни автоматического удаления документов	auto_delete_days	integer	Число дней, после которого завершенный документ (подписанный или отмененный или отклоненный) автоматически удаляется
Срок действия документа после истечения срока действия	auto_expire_after	date-time	Дата и время, вычисляемые с помощью auto_expire_days которого не завершенный документ будет автоматически истек
Срок действия документа автоматически истекает	auto_expire_days	integer	Число дней, после которого истекает срок действия незавершенного документа
URL-адрес обратного вызова событий документа	events_callback_url	uri	URL-адрес, по которому для получения обратных вызовов событий для этого документа
Внешний идентификатор документа	external_id	string	Идентификатор, используемый для ссылки на документ во внешней системе
Файл документа	file	uri	Временный URL-адрес исходного файла истекает через пять минут.
Файл документа как pdf	file_as_pdf	uri	Временный URL-адрес исходного файла в формате PDF истекает через пять минут.
Файл документа из содержимого	file_from_content	string	Содержимое документа в кодировке Base64
Файл документа из имени содержимого	file_from_content_name	string	Имя файла, включая расширение. Обязательный при использовании file_from_content.
Файл из sf	file_from_sf	FileFromSf
Файл документа из URL-адреса	file_from_url	uri	Общедоступный URL-адрес документа для скачивания с помощью SignRequest
Идентификатор внешнего интерфейса документа	frontend_id	string	Общий секрет, используемый в сочетании с клиентом SignRequest-js для предоставления пользователю доступа к документу, который не является членом команды документа
Имя документа	name	string	По умолчанию используется имя файла, включая расширение
Документ PDF	pdf	uri	Временный URL-адрес для подписанного документа в формате PDF, истекает через пять минут.
prefill_tags	prefill_tags	array of InlinePrefillTags	Входные данные перед заполнением подписывания см. в тегах предварительной заполнения
Обработка документов	processing	boolean	Указывает, является ли изменение документа обработкой, а PDF-файл может быть устаревшим. Рекомендуется дождаться завершения обработки перед загрузкой PDF-файла. Веб-перехватчики не отправляются до завершения обработки.
Песочница документа	sandbox	boolean	Указывает, был ли документ создан в составе команды песочницы
Хэш безопасности документов	security_hash	string	Хэш SHA256 содержимого PDF
Подписывание журнала PDF	signing_log.pdf	uri	Временный URL-адрес для подписывания журнала истекает через пять минут.
Хэш безопасности журнала подписывания	signing_log.security_hash	string	Хэш SHA256 содержимого PDF
Отключение вложений signrequest	signrequest.disable_attachments	boolean	Отключение отправки и добавления вложений
Signrequest Disable Blockchain Proof	signrequest.disable_blockchain_proof	boolean	Отключает хэши метки времени в интеграции блокчейна.
Дата отключения signrequest	signrequest.disable_date	boolean	Отключение добавления дат
Отключение сообщений электронной почты signrequest	signrequest.disable_emails	boolean	Отключите все сообщения о состоянии SignRequest, а также сообщения электронной почты, содержащие подписанные документы
Отключение текста signrequest	signrequest.disable_text	boolean	Отключение добавления текста
Signrequest Disable Text Signatures	signrequest.disable_text_signatures	boolean	Отключение использования подписей, созданных путем ввода (текста)
Signrequest Disable Upload Signatures	signrequest.disable_upload_signatures	boolean	Отключение использования отправленных подписей (изображений)
Signrequest From Email	signrequest.from_email	email	Электронная почта пользователя, отправляющего SignRequest (должна быть проверенной электронной почтой)
Signrequest From Email Name	signrequest.from_email_name	string	Имя, используемое в заголовке From электронной почты, например. {from_email_name} <no-reply@signrequest.com>
Signrequest подготавливается	signrequest.is_being_prepared	boolean	Предоставитель SignRequest подготовьте документ перед отправкой запроса, см. статью "Подготовка с помощью веб-интерфейса"
Сообщение Signrequest	signrequest.message	string	Сообщение, включаемое в электронную почту SignRequest, может содержать следующие html-теги: a, emabbracronymbblockquotecodeiulliolstrong
URL-адрес подготовки signrequest	signrequest.prepare_url	uri
URL-адрес перенаправления signrequest	signrequest.redirect_url	uri	URL-адрес, на который SignRequest будет перенаправлен при подписании документа
Url-адрес перенаправления Signrequest отклонен	signrequest.redirect_url_declined	uri	URL-адрес, по которому SignRequest перенаправляется, когда документ отклоняется
required_attachments	signrequest.required_attachments	array of RequiredAttachment
Напоминания о отправке signrequest	signrequest.send_reminders	boolean	Автоматически напоминать подписывателям подписывать документ, см. статью "Автоматические напоминания"
подписыватели	signrequest.signers	array of Signer
Тема Signrequest	signrequest.subject	string	Тема сообщения электронной почты SignRequest
Проверка текстового сообщения signrequest заблокирована	signrequest.text_message_verification_locked	boolean	Если требуется проверка текстового сообщения, прежде чем подписыватель сможет просмотреть документ
Signrequest Uuid	signrequest.uuid	string
Signrequest, который	signrequest.who	string	m: только я, mo: я и другие, o: только другие
Состояние документа	status	string	co: converting, ne: new, se: sent, vi: viewed, si: signed, : downloaded, sd: подписанный doи скачанный, ca: отменено, de: отклоненоec, : преобразование ошибок, es: отправка ошибок, : отправка ошибок, xp: истек срок действия
Имя группы	team.name	string
Поддомен команды	team.subdomain	uri
URL-адрес группы	team.url	uri
Шаблон документа	template	uri
URL-адрес документа	url	uri
User	user	User
Документ Uuid	uuid	string

DocumentAttachment

Имя	Путь	Тип	Описание
Документ вложения документа	document	uri
Файл вложения документа	file	uri	Временный URL-адрес для вложения документа истекает через пять минут.
Файл вложения документа из содержимого	file_from_content	string	Содержимое документа в кодировке Base64
Файл вложения документа из имени содержимого	file_from_content_name	string	Имя файла, включая расширение. Обязательный при использовании file_from_content.
Файл вложения документа из URL-адреса	file_from_url	uri	Общедоступный URL-адрес документа для скачивания с помощью SignRequest
Имя вложения документа	name	string	По умолчанию используется имя файла, включая расширение
URL-адрес вложения документа	url	uri
Uuid для вложения документа	uuid	string

FileFromSf

Имя	Путь	Тип	Описание
Идентификатор объекта	object_id	string
Тип объекта	object_type	string
Uid	uid	string

InlinePrefillTags

Входные данные перед заполнением подписывания см. в тегах предварительной заполнения

Имя	Путь	Тип	Описание
Флажок "Перед заполнением тегов"	checkbox_value	boolean
Значение даты даты перед заполнением тегов	date_value	date
Внешний идентификатор тегов предварительной заполнения	external_id	string
Текст тегов предварительной заполнения	text	string

RequiredAttachment

Имя	Путь	Тип	Описание
Обязательное имя вложения	name	string
Обязательный код вложения Uuid	uuid	string

SignRequestQuickCreate

Имя	Путь	Тип	Описание
Автоматическое удаление дней	auto_delete_days	integer	Число дней, после которого завершенный документ (подписанный или отмененный или отклоненный) автоматически удаляется
Автоматическое истечение срока действия дней	auto_expire_days	integer	Число дней, после которого истекает срок действия незавершенного документа
Отключение вложений	disable_attachments	boolean	Отключение отправки и добавления вложений
Отключение проверки блокчейна	disable_blockchain_proof	boolean	Отключает хэши метки времени в интеграции блокчейна.
Отключить дату	disable_date	boolean	Отключение добавления дат
Отключение сообщений электронной почты	disable_emails	boolean	Отключите все сообщения о состоянии SignRequest, а также сообщения электронной почты, содержащие подписанные документы
Отключение текста	disable_text	boolean	Отключение добавления текста
Отключение текстовых подписей	disable_text_signatures	boolean	Отключение использования подписей, созданных путем ввода (текста)
Отключение подписей отправки	disable_upload_signatures	boolean	Отключение использования отправленных подписей (изображений)
Документ	document	uri
URL-адрес обратного вызова событий	events_callback_url	uri	URL-адрес, по которому для получения обратных вызовов событий для этого документа
Внешний идентификатор	external_id	string	Идентификатор, используемый для ссылки на документ во внешней системе
Файл	file	uri	Временный URL-адрес исходного файла истекает через пять минут.
Файл из содержимого	file_from_content	byte	Содержимое документа в кодировке Base64
Файл из имени содержимого	file_from_content_name	string	Имя файла, включая расширение. Обязательный при использовании file_from_content.
Файл из URL-адреса	file_from_url	uri	Общедоступный URL-адрес документа для скачивания с помощью SignRequest
Из электронной почты	from_email	email	Электронная почта пользователя, отправляющего SignRequest (должна быть проверенной электронной почтой)
Имя электронной почты	from_email_name	string	Имя, используемое в заголовке From электронной почты, например. {from_email_name} <no-reply@signrequest.com>
Идентификатор внешнего интерфейса	frontend_id	string	Общий секрет, используемый в сочетании с клиентом SignRequest-js для предоставления пользователю доступа к документу, который не является членом команды документа
Готовится	is_being_prepared	boolean	Предоставитель SignRequest подготовьте документ перед отправкой запроса, см. статью "Подготовка с помощью веб-интерфейса"
Message	message	string	Сообщение, включаемое в электронную почту SignRequest, может содержать следующие html-теги: a, emabbracronymbblockquotecodeiulliolstrong
Имя	name	string	По умолчанию используется имя файла, включая расширение
prefill_tags	prefill_tags	array of InlinePrefillTags	Входные данные перед заполнением подписывания см. в тегах предварительной заполнения
Url-адрес подготовки	prepare_url	uri
URL-адрес перенаправления	redirect_url	uri	URL-адрес, на который SignRequest будет перенаправлен при подписании документа
Url-адрес перенаправления отклонен	redirect_url_declined	uri	URL-адрес, по которому SignRequest перенаправляется, когда документ отклоняется
required_attachments	required_attachments	array of RequiredAttachment	Вложения, которые подписываются, необходимы для отправки
Отправка напоминаний	send_reminders	boolean	Автоматически напоминать подписывателям подписывать документ, см. статью "Автоматические напоминания"
подписыватели	signers	array of Signer
Команда	subdomain	string
Тема	subject	string	Тема сообщения электронной почты SignRequest
Template	template	uri
Заблокирована проверка текстового сообщения	text_message_verification_locked	boolean	Если требуется проверка текстового сообщения, прежде чем подписыватель сможет просмотреть документ
URL-адрес	url	uri
Uuid	uuid	string
Кто	who	string	m: только я, mo: я и другие, o: только другие

Подписавшее лицо

Имя	Путь	Тип	Описание
Подписыватель после документа	after_document	uri
Только подписыватель утверждает	approve_only	boolean	Требовать, чтобы пользователь одобрил документ (без добавления подписи), см. статью "Утвердить только"
attachments	attachments	array of SignerAttachment
Отклонил подписыватель	declined	boolean
Подписыватель отказался	declined_on	date-time
Отображаемое имя подписи	display_name	string
Скачанный подписыватель	downloaded	boolean
Электронная почта подписывющего средства	email	email
Просмотр электронной почты подписывателя	email_viewed	boolean
Подписыватель по электронной почте	emailed	boolean
URL-адрес внедрения подписи	embed_url	uri
Идентификатор пользователя url-адреса внедрения signer	embed_url_user_id	string
Имя подписывающего пользователя	first_name	string
Язык принудительного подписывания	force_language	boolean
Подписыватель переадресован	forwarded	boolean
Переадресация подписывателя	forwarded_on	date-time
Причина переадресации подписывющего средства	forwarded_reason	string
Подписыватель пересылается по электронной почте	forwarded_to_email	email
Вход пользователя	in_person	boolean	При использовании в сочетании с URL-адресом внедрения для отправителя после того, как отправитель подписал, они будут перенаправлены на следующий in_person подписыватель, см. статью "Пользователь"
входные данные	inputs	array of SignerInputs
Язык подписи	language	string
Фамилия подписывющего пользователя	last_name	string
Сообщение о подписывшем	message	string
Подписыватель должен подписаться	needs_to_sign	boolean	Если false пользователю не нужно подписаться, но будет получена копия подписанного документа и журнала подписывания, см. статью "Копировать только"
Только уведомление подписывющего пользователя	notify_only	boolean	Отправка уведомлений о документе и копии подписанного документа и журнала подписывания, но не требует выполнения каких-либо действий, см. в статье "Уведомление только для уведомления".
Порядок подписывания	order	integer
Пароль для подписывания	password	string	Прежде чем подписывать документ, необходимо ввести этот пароль. Это поле только для записи.
URL-адрес перенаправления подписывающего пользователя	redirect_url	uri
Url-адрес перенаправления подписывающего пользователя отклонен	redirect_url_declined	uri
Подписанный подписыватель	signed	boolean
Вход в систему	signed_on	date-time
Подписыватель использует метку только для утверждения	use_stamp_for_approve_only	boolean	Поместите метку утверждения в документ, когда подписыватель утверждает документ
Подписыватель проверяет банковский счет	verify_bank_account	string
Подписыватель проверяет номер телефона	verify_phone_number	string
Просмотр подписыватель	viewed	boolean

SignerAttachment

Имя	Путь	Тип	Описание
Файл	file	uri
for_attachment	for_attachment	RequiredAttachment
Имя	name	string	По умолчанию используется имя файла
Uuid	uuid	string

SignerInputs

Имя	Путь	Тип	Описание
Значение флажка	checkbox_value	boolean
Значение даты	date_value	date
Внешний идентификатор	external_id	string
Индекс страницы	page_index	integer
Заполнитель uuid	placeholder_uuid	string
Текст	text	string
Тип	type	string

User

Имя	Путь	Тип	Описание
Отображаемое имя пользователя	display_name	string
Адрес электронной почты пользователя	email	email
Имя пользователя	first_name	string
Фамилия пользователя	last_name	string