SignNow

SignNow обеспечивает безопасные, совместимые и готовые к аудиту рабочие процессы eSignature для предприятий, юридических, кадров, здравоохранения и финансовых групп. Отправка и отслеживание запросов подписи в порядке на основе ролей, предварительно заполнение полей документов и управление группами документов с помощью соединителя SignNow.

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

Услуга	Class	Регионы
Copilot Studio	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Логические приложения	Стандарт	Все регионы Logic Apps , кроме следующих: — Регионы Azure Для Китая - Министерство обороны США (DoD)
Power Apps	Премия	Все регионы Power Apps , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)
Power Automate	Премия	Все регионы Power Automate , кроме следующих: - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD)

Контакт
Имя	Центр справки
URL	https://support.signnow.com/
Адрес электронной почты	integrations@pdffiller.com

Метаданные соединителя
Publisher	DaDaDocs
Website	https://signnow.com
Политика конфиденциальности	https://www.signnow.com/privacy_policy
Категории	Продуктивность; Кадровые ресурсы

Соединитель SignNow

Pre-requisites

Для продолжения потребуется учетная запись SignNow и подписка API SignNow.

Развертывание примера

Сначала обновите значение clientId в apiProperties.json собственным.

Выполните следующие команды и следуйте инструкциям.

paconn create --api-def apiDefinition.swagger.json --api-prop apiProperties.json --secret <client_secret>

Поддерживаемые действия и триггеры

Дополнительные сведения см. в документации .

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

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

Действия

Замена получателей в приглашении группы документов	Это действие заменяет получателей приглашения в группе документов своим идентификатором приглашения. Вы также можете задать срок действия приглашения, напоминания, переназначить разрешения и отклонить параметры для каждого документа.
Замена получателей в приглашении на документ	Это действие заменяет получателей в приглашении документа на основе их ролей. Он также позволяет обновлять параметры приглашения, такие как тип проверки подлинности, дни окончания срока действия и другие дополнительные параметры для каждой роли.
Не рекомендуется — приглашение для входа	Действие устарело. Пригласите других пользователей заполнить и подписать документ
Не рекомендуется — приглашение расширенного документа	Действие устарело. Пригласить запрос с определяемой вручную схемой. Он позволяет настроить приглашение для документа, который будет создан в будущем
Не рекомендуется. Приглашение подписать группу документов	Действие устарело. Пригласите других пользователей, чтобы заполнить и подписать группу документов
Отмена приглашения	Отмена приглашения подписи
Отправка документа	Отправка документа в SignNow
Получение групп документов	Получение списка групп документов пользователя
Получение группы документов	Получение списка групп документов пользователя
Получение полей документа	Получение значений из заполняемых полей в документе
Получение полей документа [НЕ РЕКОМЕНДУЕТСЯ]	Это действие устарело. Вместо этого используйте поля документов. ~~Получение значений поля документа.~~
Получение сведений о документе	Получение свойств документа, таких как имя, идентификатор, даты создания и обновления и т. д.
Получение состояния приглашения группы документов	Это действие извлекает сведения о приглашении группы документов, включая состояние каждого шага и действия.
Получение состояния приглашения документов	Это действие извлекает сведения о приглашении документа, включая состояние каждого шага и действия.
Получение списка документов	Получение списка документов пользователя
Получение схемы документа [DEPRECATED]	Это действие устарело. Вместо этого используйте схему документа Get . ~~Получение схемы документа OpenAPI~~
Предварительные значения смарт-полей группы документов	Автоматическое заполнение смарт-полей в документах определенными значениями
Предварительные значения смарт-поля	Предварительные заполнение значений смарт-поля для указанного документа
Предзаполнения значений полей группы документов	Автоматическое заполнение полей в документах определенными значениями
Предзаполнения значений полей документа	Автоматическое заполнение полей в документе определенными значениями
Предзаполнения значений полей документа [DEPRECATED]	Это действие устарело. Вместо этого используйте значения поля предзаполнения документа . ~~Перед заполнением значений полей и свойств.~~
Приглашение подписать группу документов	Это действие создает приглашение для подписывания группы документов. Вы можете настроить рабочий процесс с несколькими шагами, где разные получатели действуют в группе документов на разных этапах
Приглашение подписать документ	Это действие создает и отправляет приглашение на поле для подписи документа
Скачивание документа	Скачивание документа из SignNow
Создание внедренного приглашения в группу документов	Это действие создает внедренное приглашение подписывания для группы документов. После создания приглашения создайте внедренную ссылку для подписи
Создание внедренной ссылки для отправки группы документов	Это действие создает внедренную ссылку на отправку для определенной группы документов, позволяя сторонним пользователям подготовить и отправить группу документов для подписи
Создание группы документов из нескольких файлов	Создание группы документов путем отправки нескольких файлов в виде строк в кодировке Base64
Создание группы документов из шаблона группы	Создание группы документов из выбранного шаблона группы
Создание документа из шаблона	Создание документа из выбранного шаблона
Создание приглашения на внедрение документов	Это действие создает внедренное приглашение подписывания для документа. После создания приглашения создайте внедренную ссылку для подписи
Создание ссылки на внедренное приглашение группы документов	Это действие создает ссылку для внедренного приглашения в группу документов
Создание ссылки на отправку внедренных документов	Это действие создает внедренную ссылку на отправку для определенного документа, что позволяет сторонним пользователям подготавливать и отправлять документ для подписи.
Создание ссылки на приглашение встраиваемого документа	Это действие создает ссылку для внедренного документа приглашения
Создание ссылки подписывания	Создайте ссылку на документ и предоставьте ему общий доступ к документу
Удаление внедренного приглашения группы документов	Это действие удаляет внедренное приглашение для определенной группы документов
Удаление документа	Удаление документа из SignNow
Удаление приглашения на внедрение документов	Это действие удаляет внедренное приглашение для документа

Замена получателей в приглашении группы документов

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

Это действие заменяет получателей приглашения в группе документов своим идентификатором приглашения. Вы также можете задать срок действия приглашения, напоминания, переназначить разрешения и отклонить параметры для каждого документа.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов
Идентификатор приглашения	invite_id	True	string	Идентификатор приглашения группы документов
Идентификатор шага	step_id		string	Идентификатор шага приглашения из приглашения группы документов
Получатель для замены	recipient_to_update		string	Сообщение электронной почты получателя для замены
Новый получатель	new_recipient		string	Электронная почта нового получателя
Срок действия дней	expiration_days		integer	В сколько дней истекает срок действия приглашения; Максимум 30 дней
Напоминание	reminder		integer	В сколько дней отправить напоминание в подписыватель; Максимум 30 дней
Идентификатор документа	document_id	True	string	Идентификатор документа из группы документов
Разрешить перенаправление	allow_forwarding		boolean	Следует ли разрешить получателям переназначить это приглашение на другой адрес электронной почты. Возможные значения: False — запрещено. True — разрешено.
Разрешить отклонение по подписи	decline_by_signature		boolean	Определяет, следует ли отображать параметр "Отклонить для входа" в полях подписи. True: показать параметр отклонить; False: скрытие параметра отклонить

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

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние замены получателей

Замена получателей в приглашении на документ

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

Это действие заменяет получателей в приглашении документа на основе их ролей. Он также позволяет обновлять параметры приглашения, такие как тип проверки подлинности, дни окончания срока действия и другие дополнительные параметры для каждой роли.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа
Role	role	True	string	Имя роли получателя, который нужно заменить
Новая электронная почта	email	True	string	Новая электронная почта получателя
Role	role	True	string	Имя роли, требующее дополнительных параметров приглашения
Срок действия дней	expiration_days		integer	В сколько дней истекает срок действия приглашения. Максимум 30 дней
Разрешить отклонение по подписи	decline_by_signature		boolean	Определяет, следует ли отображать параметр "Отклонить для входа" в полях подписи. True: показать параметр отклонить; False: скрытие параметра отклонить
Напоминание	reminder		integer	В сколько дней отправить напоминание получателю. Максимум 30 дней
Тип проверки подлинности	authentication_type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль проверки подлинности	authentication_password		string	Пароль для проверки подлинности подписывющего пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон проверки подлинности	authentication_phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Sms-сообщение проверки подлинности	authentication_sms_message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456". Пример. Введите пароль {password} для разблокировки документа

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

Имя	Путь	Тип	Описание
Замены	replacements	array of object	Сведения о новых получателях
Новый идентификатор приглашения	replacements.new_invite_id	string	Идентификатор приглашения нового поля
Role	replacements.role	string	Имя роли получателя, который был заменен
Новая электронная почта	replacements.new_email	string	Новая электронная почта получателя

Не рекомендуется — приглашение для входа

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

Действие устарело. Пригласите других пользователей заполнить и подписать документ

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template	True	boolean	Укажите, должны ли быть извлечены документы или шаблоны
Документ	template_id	True	string	Выбор шаблона из списка
body	body	True	dynamic

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

response: object

Не рекомендуется — приглашение расширенного документа

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	string	Укажите идентификатор документа
Имя	role		string	Имя роли подписывющего пользователя
Эл. почта	email		email	Указание электронной почты для подписыватель
Номер телефона (приглашение через SMS)	phone_invite		string	Укажите номер телефона получателя +XXXXXXXXXXX. Требуется для приглашения через SMS.
Заказ	order		integer	Настройка порядка подписывания для нескольких подписчиков
Персонализированная тема	subject		string	Добавление персонализированной темы для подписывателя
Персонализированное сообщение	message		string	Добавление персонализированного сообщения для signer
Тип аутентификации	authentication_type		string	Проверка удостоверения пользователя с помощью пароля, SMS или телефонного звонка
Пароль	password		string	Установка пароля для пароля типа проверки подлинности
Телефон	phone		string	Укажите номер телефона +XXXXXXXXXXXX для типа проверки подлинности Phone или SMS
Дни до истечения срока действия	expiration_days		integer	Получение уведомления о том, сколько дней истекает срок действия приглашения
Отправка напоминания в	reminder		integer	Количество дней после отправки приглашения на автоматическое отслеживание с помощью напоминания по электронной почте
Отправка напоминаний каждые X дней	remind_repeat		integer	Получатель получит сообщение электронной почты с напоминанием о каждом наборе дней.
Разрешить перенаправление	reassign		boolean	Разрешить подписыватель делегировать подписывание другому пользователю
Показать отклонение подписи	decline_by_signature		boolean	Метка поля подписи как "Отклонить" для подписи, если получатель отказался подписать документ
КРЕДИТНАЯ КАРТА	cc		string	Разделенные запятыми сообщения электронной почты, которые будут скопированы в приглашении
Тема	subject		string	Введите тему
Message	message		string	Введите сообщение
Электронная почта всех сторон при завершении	on_complete		string	Все стороны получают уведомление по электронной почте при подписании документа

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

response: object

Не рекомендуется. Приглашение подписать группу документов

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

Действие устарело. Пригласите других пользователей, чтобы заполнить и подписать группу документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template	True	boolean	Укажите, следует ли извлекать группы документов или шаблоны групп
Группа документов	template_group_id	True	string	Выберите группу документов из списка
body	body	True	dynamic

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

response: object

Отмена приглашения

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

Отмена приглашения подписи

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	string	Указание идентификатора документа для отмены приглашения подписи

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

response: object

Отправка документа

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

Отправка документа в SignNow

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Файл	file	True	file	Отправка файла

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

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа

Получение групп документов

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

Получение списка групп документов пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template	True	boolean	Укажите, следует ли извлекать группы документов или шаблоны групп
Лимит	limit		integer	Общее количество возвращаемых элементов (от 1 до 50)
Смещение	offset		integer	Смещение (от нуля) первого элемента в коллекции для возврата

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

Тело: DocumentGroupsResponse

Получение группы документов

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

Получение списка групп документов пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Шаблон группы	doc_group_id	True	string	Выберите шаблон группы из списка
Template	template	True	boolean	Укажите, следует ли извлечь группу документов или шаблон группы

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

Тело: DocumentGroupProperties

Получение полей документа

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

Получение значений из заполняемых полей в документе

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_id	True	string	Указание шаблона документа для получения полей из
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа

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

Выходные данные этой операции являются динамическими.

Получение полей документа [НЕ РЕКОМЕНДУЕТСЯ]

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

Это действие устарело. Вместо этого используйте поля документов.

~~Получение значений поля документа.~~

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_id	True	string	Указание шаблона документа для получения полей из
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа

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

Выходные данные этой операции являются динамическими.

Получение сведений о документе

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

Получение свойств документа, таких как имя, идентификатор, даты создания и обновления и т. д.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template	True	boolean	Укажите, должны ли быть извлечены документы или шаблоны
Идентификатор документа	doc_id	True	string	Укажите уникальный идентификатор документа или выберите документ из списка.

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

Тело: DocumentProperties

Получение состояния приглашения группы документов

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

Это действие извлекает сведения о приглашении группы документов, включая состояние каждого шага и действия.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов

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

Имя	Путь	Тип	Описание
Идентификатор приглашения группы документов	document_group_invite_id	string	Идентификатор приглашения группы документов
Состояние группы документов	status	string	Состояние подписывания группы документов. Возможные значения: "создано", "ожидание", "выполнено", "отменено"
Адрес электронной почты владельца	owner_email	string	Адрес электронной почты владельца группы документов
Отклонить группу документов	is_document_declined	boolean	Возвращает значение true, если любой документ в группе отказывается от подписывающего или утверждающего; в противном случае возвращает значение false
steps	steps	array of object	Этапы
Идентификатор шага	steps.step_id	string	Идентификатор шага из приглашения группы документов
Порядок подписывания	steps.signing_order	integer	Порядок подписывания
Идентификатор документа	steps.document_id	string	Идентификатор документа
Имя документа	steps.document_name	string	Имя документа
Электронная почта подписывющего средства	steps.signer_email	string	Адрес электронной почты получателя
Имя роли	steps.role_name	string	Имя роли получателя
Тип действия	steps.action_type	string	Действие, необходимое для получателя в документе. Возможные значения: Sign, View, "Утвердить" или "FreeFormSign"
Идентификатор приглашения на шаг	steps.invite_id	string	Идентификатор шага приглашения
Состояние	steps.status	string	Состояние подписи шага
Declined	steps.declined	boolean	Значение true, если получатель на этом шаге отказался от документа
Причина отклонения	steps.decline_reason	string	Сообщение, предоставленное получателем при отклонении документа
Создано	steps.created	integer	Дата создания шага
Updated	steps.updated	integer	Дата последнего обновления состояния шага

Получение состояния приглашения документов

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

Это действие извлекает сведения о приглашении документа, включая состояние каждого шага и действия.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа

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

Имя	Путь	Тип	Описание
Отклонить документ	is_document_declined	boolean	Значение True, если документ был отклонен подписывающего или утверждающего, в противном случае — значение false.
steps	steps	array of object	Этапы
Порядок подписывания	steps.signing_order	integer	Порядок подписывания
Электронная почта получателя	steps.signer_email	string	Адрес электронной почты получателя
Имя роли	steps.role_name	string	Имя роли получателя
Тип действия	steps.action_type	string	Действие, необходимое для получателя в документе. Возможные значения: Sign, View, "Утвердить" или "FreeFormSign"
Идентификатор приглашения	steps.invite_id	string	Идентификатор приглашения
Состояние	steps.status	string	Состояние подписи. Возможные значения: "создано", "ожидание", "выполнено", "отменено", "пропущено"
Declined	steps.declined	boolean	Возвращает значение true, если получатель этого шага отказался от документа
Причина отклонения	steps.decline_reason	string	Сообщение, предоставленное получателем при отклонении документа
Создано	steps.created	integer	Дата создания шага
Updated	steps.updated	integer	Дата последнего обновления состояния шага

Получение списка документов

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

Получение списка документов пользователя

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template		boolean	Укажите, должны ли быть извлечены документы или шаблоны
Включить шаблон по умолчанию	includeDefaultTemplate		boolean	Укажите, следует ли добавить шаблон по умолчанию в список шаблонов

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

response: array of DocumentProperties

Получение схемы документа [DEPRECATED]

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

Это действие устарело. Вместо этого используйте схему документа Get .

~~Получение схемы документа OpenAPI~~

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id		string	Указание уникального идентификатора документа
Фильтр типа поля	select		string	Разделите запятыми, какие типы полей вы хотите извлечь

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

Имя	Путь	Тип	Описание
properties	properties	object

Предварительные значения смарт-полей группы документов

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

Автоматическое заполнение смарт-полей в документах определенными значениями

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_group_id	True	string	Указание шаблона группы документов для получения полей из
Идентификатор группы документов	doc_group_id	True	string	Указание уникального идентификатора группы документов
столбцов	fields		dynamic

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

Имя	Путь	Тип	Описание
Идентификатор группы документов	id	DocumentGroupId	Уникальный идентификатор группы документов

Предварительные значения смарт-поля

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

Предварительные заполнение значений смарт-поля для указанного документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_id	True	string	Указание шаблона документа для получения полей из
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа
столбцов	fields		dynamic

Предзаполнения значений полей группы документов

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

Автоматическое заполнение полей в документах определенными значениями

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_group_id	True	string	Указание шаблона группы документов для получения полей из
Идентификатор группы документов	doc_group_id	True	string	Указание уникального идентификатора группы документов
столбцов	fields		dynamic

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

Имя	Путь	Тип	Описание
Идентификатор группы документов	id	DocumentGroupId	Уникальный идентификатор группы документов

Предзаполнения значений полей документа

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

Автоматическое заполнение полей в документе определенными значениями

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_id	True	string	Указание шаблона документа для получения полей из
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа
столбцов	fields		dynamic

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

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа

Предзаполнения значений полей документа [DEPRECATED]

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

Это действие устарело. Вместо этого используйте значения поля предзаполнения документа .

~~Перед заполнением значений полей и свойств.~~

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Template	template_id	True	string	Указание шаблона документа для получения полей из
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа
столбцов	fields		dynamic

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

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа

Приглашение подписать группу документов

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

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов
Заказ	order	True	integer	Порядок подписывания: 1 — получатели сначала подписывают группу документов, а затем группу документов отправляют в 2,3 и т. д. Несколько получателей могут содержать один и тот же порядок подписывания
Адрес электронной почты	email		string	Адрес электронной почты получателя
Группа электронной почты	email_group		string	Группа контактов получателей
Имя роли	role_name	True	string	Имя роли получателя в документе (можно использовать для идентификации полей в документе, назначенном этому конкретному получателю).
Действие	action	True	string	Разрешенное действие с документом. Возможные значения: Просмотр, знак, утверждение
Идентификатор документа	document_id	True	string	Идентификатор документа, для которого требуются действия от этого получателя
Обязательное имя предустановки подписи	required_preset_signature_name		string	Предварительно заполненный текст для поля подписи, заблокированный для редактирования получателем
Разрешить перенаправление	allow_reassign		boolean	Определяет, может ли получатель перенаправить приглашение на другой адрес электронной почты. True: получатель может перенаправить приглашение; False: получатель не может перенаправить приглашение
Разрешить отклонение по подписи	decline_by_signature		boolean	Определяет, следует ли отображать параметр "Отклонить для входа" в полях подписи. True: показать параметр отклонить; False: скрытие параметра отклонить
Тип проверки подлинности	type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль	value		string	Пароль для проверки подлинности подписывющего пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон	phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Message	message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456".
MerchantId	merchant_id		string	Идентификатор учетной записи продавца, добавленной в организацию
Валюта	currency		string	Запрошенная валюта оплаты
Сумма	amount		string	Запрошенная сумма оплаты
Ури	redirect_uri		string	Когда все запрошенные поля завершены и подписаны, подписыватель перенаправляется в этот универсальный код ресурса (URI)
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.
Uri перенаправления отклонить	decline_redirect_uri		string	Ссылка, открывающаяся после того, как документ был отклонен получателем
Закрыть URI перенаправления	close_redirect_uri		string	Ссылка, которая открывается, когда подписыватель нажимает кнопку "Сохранить ход выполнения" и "Завершить позже" во время сеанса подписывания или закрытия в режиме просмотра
Отмена перенаправления завершена	is_finish_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления завершения для организации. True — перенаправление отменено; False — перенаправление остается активным
Отменено закрытие перенаправления	is_close_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления хода сохранения для организации. True — перенаправление отменено; False — перенаправление остается активным
Отмена перенаправления	is_decline_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления для организации. True — перенаправление отменено; False — перенаправление остается активным
Language	language		string	Задает язык сеанса подписывания и сообщений электронной почты уведомлений для подписывающего пользователя. Возможные значения: En для английского, Es для испанского и fr для французского. Если он не задан, язык определяется языком учетной записи SignNow.
Заказ	order	True	integer	Порядок подписывания: 1 — получатели сначала подписывают группу документов, а затем группу документов отправляют в 2,3 и т. д. Несколько получателей могут содержать один и тот же порядок подписывания
Адрес электронной почты	email	True	string	Адрес электронной почты получателя
Группа электронной почты	email_group		string	Группа контактов получателей
Тема	subject		string	Пользовательская тема электронной почты для получателя
Message	message		string	Настраиваемое сообщение электронной почты для получателя
Дни до истечения срока действия	expiration_days		integer	В x днях срок действия приглашения истекает (от 3 до 180 дней)
Отправка напоминания в X днях	remind_after		integer	Через несколько дней после приглашения получатель получает сообщение электронной почты напоминания (от 1 до 179 дней). Должно быть меньше дней окончания срока действия
Отправка напоминания в X-днях до истечения срока действия	remind_before		integer	X дней до истечения срока действия, реджепента получает сообщение электронной почты напоминания (от 1 до 179 дней). Должно быть меньше дней окончания срока действия
Отправка напоминаний каждые X дней	remind_repeat		integer	Получатель получает сообщение напоминания каждые x дней после отправки приглашения (от 1 до 7 дней)
Идентификатор	id		string	Идентификатор группы электронной почты. Уникальный 40-символьный идентификатор, который необходимо создать заранее
Имя	name		string	Имя группы. Используйте его в группе "Пригласить действия > по электронной почте"
Адрес электронной почты	email		string	Адрес электронной почты, который должен получать приглашение
Адрес электронной почты	email		string	Адрес электронной почты получателя, который получит сообщение о завершении
Отключение вложения документов	disable_document_attachment		boolean	Следует ли отключить отправку вложений документов с помощью сообщения электронной почты завершения. Возможные значения: False — включение вложения документа, True — отключение вложения документа
Тема	subject		string	Пользовательская тема для сообщения электронной почты завершения
Message	message		string	Настраиваемое сообщение для сообщения электронной почты завершения
Подписывание как объединенный	sign_as_merged		boolean	Если значение true, позволяет пользователю API отправлять приглашение, которое открывается как объединенная группа документов в одном документе.
Метка времени клиента	client_timestamp		integer	Метка времени приглашения группы документов
Адрес электронной почты	email		string	Адрес электронной почты, который должен получать приглашение
Подпись QES	signature		string	Тип QES. Возможные значения: Eideasy, Nom151. Используется для запроса подписей QES от подписчиков. Все подписи в приглашении должны использовать один и тот же тип подписи. Чтобы создать приглашение с помощью QES, пользователь должен принадлежать организации с включенным QES

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

Имя	Путь	Тип	Описание
Идентификатор	id	string	Идентификатор приглашения группы документов
Ссылка "Ожидающее приглашение"	pending_invite_link	string	Ссылка на ожидающее приглашение

Приглашение подписать документ

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

Это действие создает и отправляет приглашение на поле для подписи документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа
Адрес электронной почты	email		string	Адрес электронной почты получателя
Группа электронной почты	email_group		string	Группа пользователей, которая должна получать приглашение. Когда один из пользователей подписывает документ, считается завершенным. Необходимо использовать с расширенным параметром "группы электронной почты". Требуется, если параметр "Электронная почта" или "Приглашение на телефон" не добавлен, но его нельзя использовать одновременно с любой из этих параметров.
Приглашение на телефон	phone_invite		string	Номер телефона получателя. Требуется для приглашения через SMS
Role	role	True	string	Имя роли получателя. Например, Signer 1, Signer 2
Заказ	order	True	integer	Порядок подписывания. Порядок подписывания определяет последовательность, в которой получатели должны подписать или заполнить документ. После завершения подписывания всех получателей на шаге заказа документ переходит к следующему шагу заказа (например, 2, 3). Несколько получателей могут совместно использовать один и тот же порядок подписывания
Role	role	True	string	Имя роли получателя, используемое для сопоставления расширенных параметров
Имя подписи перед заполнением	prefill_signature_name		string	Предварительно заполненный текст в поле сигнатуры, доступный для редактирования с помощью подписи
Обязательное имя предустановки подписи	required_preset_signature_name		string	Предварительно заполненный текст для поля подписи, заблокированный для редактирования получателем. Невозможно использовать с именем подписи перед заполнением или "Требовать новую подпись"
Требовать новую подпись	force_new_signature		boolean	Определяет, может ли подписыватель использовать сохраненную подпись. False — подписыватель может использовать сохраненную подпись; True — подписыватель должен создать новую подпись
Разрешить перенаправление	reassign		boolean	Определяет, может ли получатель перенаправить приглашение на другой адрес электронной почты. True: получатель может перенаправить приглашение; False: получатель не может перенаправить приглашение
Разрешить отклонение по подписи	decline_by_signature		boolean	Определяет, следует ли отображать параметр "Отклонить для входа" в полях подписи. True — показать параметр отклонить; false — скрытие параметра отклонить
Отправка напоминания в X днях	remind_after		integer	Через несколько дней после приглашения получатель получает сообщение электронной почты напоминания (от 1 до 179 дней). Должно быть меньше "Дни до истечения срока действия"
Отправка напоминания в X дней до истечения срока действия	remind_before		integer	X дней до истечения срока действия, реджепента получает сообщение электронной почты напоминания (от 1 до 179 дней). Должно быть меньше "Дни до истечения срока действия"
Отправка напоминания каждые X дней	remind_repeat		integer	Получатель получает сообщение напоминания каждые x дней после отправки приглашения (от 1 до 7 дней)
Дни до истечения срока действия	expiration_days		integer	В X днях срок действия приглашения истекает (от 3 до 180 дней)
Тип проверки подлинности	authentication_type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль проверки подлинности	password		string	Пароль для проверки подлинности подписывющего пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон проверки подлинности	phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Sms-сообщение проверки подлинности	authentication_sms_message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456". Пример. Введите пароль {password} для разблокировки документа
Тема	subject		string	Пользовательская тема электронной почты для получателя
Message	message		string	Настраиваемое сообщение электронной почты для получателя
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	Когда все запрошенные поля завершены и подписаны, подписыватель перенаправляется в этот универсальный код ресурса (URI)
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.
Uri перенаправления отклонить	decline_redirect_uri		string	Ссылка, открывающаяся после того, как документ был отклонен получателем
Закрыть URI перенаправления	close_redirect_uri		string	Ссылка, которая открывается, когда получатель нажимает кнопку "Сохранить ход выполнения" и "Завершить позже" во время сеанса подписывания или закрытия в режиме просмотра
Отмена перенаправления завершена	is_finish_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления завершения для организации. True — перенаправление отменено; False — перенаправление остается активным
Отменено закрытие перенаправления	is_close_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления хода сохранения для организации. True — перенаправление отменено; False — перенаправление остается активным
Отмена перенаправления	is_decline_redirect_canceled		boolean	Указывает, отменен ли параметр перенаправления для организации. True — перенаправление отменено; False — перенаправление остается активным
Language	language		string	Задает язык сеанса подписывания и сообщений электронной почты уведомлений для подписывающего пользователя. Возможные значения: En для английского, Es для испанского и fr для французского. Если он не задан, язык определяется языком учетной записи SignNow.
Адрес электронной почты	email	True	string	Адрес электронной почты средства просмотра
Role	role	True	string	Имя роли просмотра
Заказ	order	True	integer	Целое число: порядок отправки, начиная с 1
Role	role	True	string	Имя роли просмотра. Используется для сопоставления расширенных параметров
Тема	subject		string	Пользовательская тема электронной почты для средства просмотра
Message	message		string	Пользовательское сообщение электронной почты для средства просмотра
Адрес электронной почты	email	True	string	Адрес электронной почты утверждающего
Role	role	True	string	Имя роли утверждающего
Заказ	order	True	integer	Порядок получения запроса на утверждение
Role	role	True	string	Имя роли утверждающего. Используется для сопоставления расширенных параметров
Срок действия дней	expiration_days		integer	Количество дней до истечения срока действия приглашения
Message	message		string	Настраиваемое сообщение электронной почты для утверждающего
Тема	subject		string	Пользовательская тема электронной почты для утверждающего
Тип проверки подлинности	authentication_type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль	password		string	Пароль для проверки подлинности подписывющего пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон	phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Sms-сообщение проверки подлинности	authentication_sms_message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456". Пример. Введите пароль {password} для разблокировки документа
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	URL-адрес, который открывается после утверждения документа утверждающим
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.
От	from		string	Адрес электронной почты отправителя. Можно использовать только электронную почту, связанную с учетной записью SignNow (адрес электронной почты для входа). Если осталось пустым, он устанавливается автоматически.
Идентификатор	id		string	Идентификатор группы электронной почты. Уникальный 40-символьный идентификатор, который необходимо создать заранее
Имя	name		string	Имя группы. Используйте его в поле "Группа электронной почты для подписей">
Адрес электронной почты	email		string	Адрес электронной почты, который должен получать приглашение
Адрес электронной почты	email		string	Адрес электронной почты, который должен получать приглашение
Имя	name		string	Название шага
Адрес электронной почты	email		string	Адрес электронной почты получателя CC
Step	step		integer	Порядок отправки, начиная с 1
Тема	subject		string	Тема электронной почты для всех получателей
Message	message		string	Сообщение электронной почты для всех получателей
Тема CC	cc_subject		string	Тема электронной почты CC для всех получателей CC
Сообщение CC	cc_message		string	Сообщение электронной почты CC для всех получателей CC
Подпись QES	signature		string	Тип QES. Возможные значения: Eideasy, Nom151. Используется для запроса подписей QES от подписчиков. Все подписи в приглашении должны использовать один и тот же тип подписи. Чтобы создать приглашение с помощью QES, пользователь должен принадлежать организации с включенным QES

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

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние

Скачивание документа

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

Скачивание документа из SignNow

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	string	Укажите уникальный идентификатор документа или выберите документ из списка.
Формат	mode		string	Выбор формата документа для скачивания

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

response: binary

Создание внедренного приглашения в группу документов

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

Это действие создает внедренное приглашение подписывания для группы документов. После создания приглашения создайте внедренную ссылку для подписи

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов
Заказ	order	True	integer	Шаг заказа подписывания. Все подписи, назначенные конкретному `order` шагу (например, `order: 1`) получают сообщение электронной почты приглашения одновременно. Сообщения электронной почты для следующего шага заказа (например, `order: 2`) отправляются только после завершения всех действий на предыдущем шаге заказа
Адрес электронной почты	email	True	string	Адрес электронной почты получателя
Идентификатор документа	id	True	string	Идентификатор документа
Role	role		string	Роль получателя в документе. Роли не должны указываться для действия view
Действие	action	True	string	Действие, необходимое для получателя в документе. Допустимые значения: "sign", "view"
Заказ	order	True	string	Шаг заказа подписывания
Адрес электронной почты	email	True	string	Адрес электронной почты получателя
Language	language		string	Задает язык сеанса подписывания и сообщений электронной почты уведомлений для подписывающего пользователя. Возможные значения: En для английского, Es для испанского и fr для французского. Если он не задан, язык определяется языком учетной записи SignNow.
Имя (Первое имя)	first_name		string	Имя получателя
Фамилия	last_name		string	Фамилия получателя
Обязательное имя предустановки подписи	required_preset_signature_name		string	Предварительно заполненный текст для поля подписи, заблокированный для редактирования получателем
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	Ссылка, открывающаяся после завершения сеанса подписывания
Uri перенаправления отклонить	decline_redirect_uri		string	Ссылка, открывающаяся после отказа получателя подписать документ
Закрыть URI перенаправления	close_redirect_uri		string	Ссылка, которая открывается, когда получатель нажимает кнопку "Сохранить ход выполнения" и "Завершить позже" во время сеанса подписывания или закрытия в режиме просмотра
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.
Тип доставки	delivery_type		string	Определяет, как отправляется приглашение
Срок действия ссылки	link_expiration		integer	В сколько минут истекает срок действия приглашения электронной почты. Можно использовать только в том случае, если тип доставки=email. Допустимый диапазон: 15–43200 минут
Срок действия сеанса	session_expiration		integer	В сколько минут истекает срок действия сеанса подписывания. Если для этого приглашения создается ссылка, срок действия сеанса сбрасывается. Применимо только в том случае, если "Тип доставки=электронная почта" и для действий знака. Допустимый диапазон: 15–1440 минут
Тип проверки подлинности	authentication_type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль проверки подлинности	authentication_password		string	Пароль, заданный для проверки подлинности пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон проверки подлинности	authentication_phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Sms-сообщение проверки подлинности	authentication_sms_message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456". Пример. Введите пароль {password} для разблокировки документа
Подпись QES	signature		string	Тип QES. Возможные значения: Eideasy, Nom151. Используется для запроса подписей QES от подписчиков. Все подписи в приглашении должны использовать один и тот же тип подписи. Чтобы создать приглашение с помощью QES, пользователь должен принадлежать организации с включенным QES

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

Имя	Путь	Тип	Описание
Идентификатор приглашения	id	string	Идентификатор созданного внедренного приглашения

Создание внедренной ссылки для отправки группы документов

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

Это действие создает внедренную ссылку на отправку для определенной группы документов, позволяя сторонним пользователям подготовить и отправить группу документов для подписи

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов
Тип	type		string	Указывает шаг отправки, при котором внедренная ссылка должна открываться: "Управление" — открывает ссылку на странице добавления документов на страницу группы документов; "изменить": открывает ссылку в редакторе; "send-invite": открывает ссылку на странице "Отправить приглашение"
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	Страница, открывающаяся после внедренной отправки, настроена. Требуется, если добавлен целевой объект перенаправления
Срок действия ссылки	link_expiration		integer	Указывает, сколько минут ссылка останется активной. Допустимый диапазон: от 15 до 45 минут. Пользователи уровня администратора могут настроить длительность до 43200 минут.
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.

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

Имя	Путь	Тип	Описание
URL-адрес	url	string	Ссылка на отправку внедренной группы документов

Создание группы документов из нескольких файлов

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

Создание группы документов путем отправки нескольких файлов в виде строк в кодировке Base64

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Имя группы документов	group_name	True	string	Введите имя группы документов
Имя документа	name	True	string	Имя документа с расширением: Report.pdf, Letter.docx и т. д.
Содержимое файла	content	True	string	Строка в кодировке Base64, представляющая содержимое документа

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

Тело: CreateDocumentGroupFromFilesResponse

Создание группы документов из шаблона группы

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

Создание группы документов из выбранного шаблона группы

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Шаблон группы	doc_group_id	True	string	Выберите шаблон группы из списка
Имя группы документов	group_name		string	Введите новое имя группы документов

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

Имя	Путь	Тип	Описание
Идентификатор группы документов	id	DocumentGroupId	Уникальный идентификатор группы документов

Создание документа из шаблона

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

Создание документа из выбранного шаблона

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Шаблон документа	doc_id	True	string	Выбор шаблона из списка
Имя документа	document_name		string	Введите новое имя файла для документа

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

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа

Создание приглашения на внедрение документов

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

Это действие создает внедренное приглашение подписывания для документа. После создания приглашения создайте внедренную ссылку для подписи

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа
Электронная почта подписывющего средства	email	True	email	Адрес электронной почты получателя
Role	role	True	string	Имя роли получателя, например "Signer 1" (роли просмотра не поддерживаются)
Заказ	order	True	integer	Порядок подписывания
Формула имени	name_formula		string	Формула для создания имени завершенного документа с помощью префикса (любого текста) и заполняемых данных поля. Пример: "Contract\|signer_name\|signed_date", где "Контракт" является префиксом, а "signer_name" и "signed_date" — имена заполняемых полей.
Role	role	True	string	Имя роли получателя, например "Signer 1" (роли просмотра не поддерживаются)
Language	language		string	Задает язык сеанса подписывания и сообщений электронной почты уведомлений для подписывающего пользователя. Возможные значения: En для английского, Es для испанского и fr для французского. Если он не задан, язык определяется языком учетной записи SignNow.
Имя (Первое имя)	first_name		string	Имя получателя
Фамилия	last_name		string	Фамилия получателя
Обязательное имя предустановки подписи	required_preset_signature_name		string	Предварительно заполненный текст для поля подписи, заблокированный для редактирования получателем. Невозможно использовать с "prefill_signature_name" или "force_new_signature"
Имя подписи перед заполнением	prefill_signature_name		string	Строка с именем подписи, которая отображается при щелчке поля подписи. Подписыватель может изменить подпись
Требовать новую подпись	force_new_signature		boolean	Определяет, может ли подписыватель использовать сохраненную подпись или нет. Если задано значение true, подписыватель должен добавить новую подпись. Если задано значение false, подписыватель может использовать сохраненную подпись.
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	Ссылка, открывающаяся после завершения сеанса подписывания
Uri перенаправления отклонить	decline_redirect_uri		string	Ссылка, открывающаяся после отказа получателя подписать документ
Закрыть URI перенаправления	close_redirect_uri		string	Ссылка, которая открывается, когда получатель нажимает кнопку "Сохранить ход выполнения" и "Завершить позже" во время сеанса подписывания или закрытия в режиме просмотра
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.
Тип проверки подлинности	authentication_type		string	Тип проверки подлинности, используемый для проверки подлинности получателя во время сеанса подписывания. Допустимые значения: "Пароль", "Телефонный звонок" и "Sms"
Пароль проверки подлинности	authentication_password		string	Пароль для проверки подлинности подписывющего пользователя. Требуется для типа проверки подлинности "Пароль"
Телефон проверки подлинности	authentication_phone		string	Номер телефона, используемый для проверки подлинности подписи. Требуется для типа проверки подлинности "Телефонный звонок" и "Sms". Пример: +1XXXXXXXXX
Sms-сообщение проверки подлинности	authentication_sms_message		string	Пользовательское sms-сообщение, отправленное в подписыватель, содержащее заполнитель {password}. Используется с типом проверки подлинности Sms. Без этого параметра подписыватель получает sms по умолчанию с автоматически созданным паролем (код разблокировки) — "Код разблокировки документа SignNow: 123456" Пример: введите пароль {password} для разблокировки документа.
Тип доставки	delivery_type		string	Определяет, как отправляется приглашение
Срок действия ссылки	link_expiration		integer	В сколько минут истекает срок действия приглашения электронной почты. Можно использовать только в том случае, если тип доставки=email. Допустимый диапазон: 15–43200 минут
Срок действия сеанса	session_expiration		integer	В сколько минут истекает срок действия сеанса подписывания. Если для этого приглашения создается ссылка, срок действия сеанса сбрасывается. Применимо только в том случае, если "Тип доставки=электронная почта" и для действий знака. Допустимый диапазон: 15–1440 минут
Подпись QES	signature		string	Тип QES. Возможные значения: Eideasy, Nom151. Используется для запроса подписей QES от подписчиков. Все подписи в приглашении должны использовать один и тот же тип подписи. Чтобы создать приглашение с помощью QES, пользователь должен принадлежать организации с включенным QES

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

Имя	Путь	Тип	Описание
данные	data	array of object	Данные
Идентификатор	data.id	string	Идентификатор созданного внедренного приглашения
Адрес электронной почты	data.email	string	Электронная почта получателя
Идентификатор роли	data.role_id	string	Идентификатор роли получателя
Заказ	data.order	integer	Порядок подписывания получателя
Состояние	data.status	string	Состояние внедренного приглашения

Создание ссылки на внедренное приглашение группы документов

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

Это действие создает ссылку для внедренного приглашения в группу документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов
Идентификатор внедренного приглашения в группу документов	invite_id	True	string	Идентификатор внедренного приглашения группы документов из действия Create Document Group Embedded Invite
Адрес электронной почты	email	True	email	Адрес электронной почты получателя
Срок действия ссылки	link_expiration		integer	Указывает, сколько минут ссылка останется активной. Допустимый диапазон:15-45 минут
Срок действия сеанса	session_expiration		integer	Указывает, сколько минут сеанс подписывания останется активным. Допустимый диапазон:15-1440 минут

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

Имя	Путь	Тип	Описание
Ссылка внедренного приглашения	link	string	Ссылка на внедренное приглашение группы документов

Создание ссылки на отправку внедренных документов

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

Это действие создает внедренную ссылку на отправку для определенного документа, что позволяет сторонним пользователям подготавливать и отправлять документ для подписи.

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа
Тип	type		string	Указывает шаг отправки, на котором должна открыться ссылка. Возможные значения: "Пригласить": открывает страницу "Отправить приглашение" для документа, где пользователь может добавлять сообщения электронной почты, тему, сообщение и т. д. "Документ": открывает документ в редакторе для добавления заполняемых полей, а затем открывает страницу "Отправить приглашение".
Универсальный код ресурса (URI) перенаправления	redirect_uri		string	Страница, открывающаяся после внедренной отправки, настроена. Требуется, если добавлен целевой объект перенаправления
Срок действия ссылки	link_expiration		integer	Указывает, сколько минут ссылка останется активной. Допустимый диапазон: от 15 до 45 минут. Пользователи уровня администратора могут настроить длительность до 43200 минут.
Целевой объект перенаправления	redirect_target		string	Определяет, следует ли открывать URI перенаправления на новой вкладке в браузере или на той же вкладке после сеанса подписывания. Возможные значения: "На новой вкладке" — открывает ссылку на новой вкладке " В той же вкладке" — открывает ссылку на той же вкладке.

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

Имя	Путь	Тип	Описание
URL-адрес	url	string	Ссылка на отправку внедренного документа

Создание ссылки на приглашение встраиваемого документа

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

Это действие создает ссылку для внедренного документа приглашения

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа
Идентификатор приглашения на поле	field_invite_id	True	string	Внедренный идентификатор приглашения из действия Create Document Embedded Invite
Срок действия ссылки	link_expiration		integer	Указывает, сколько минут ссылка останется активной. Допустимый диапазон:15-45 минут
Срок действия сеанса	session_expiration		integer	Указывает, сколько минут сеанс подписывания останется активным. Допустимый диапазон:15-1440 минут

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

Имя	Путь	Тип	Описание
Link	data.link	string	Созданная внедренная ссылка на приглашение для документа

Создание ссылки подписывания

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

Создайте ссылку на документ и предоставьте ему общий доступ к документу

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	string	Укажите уникальный идентификатор документа или выберите документ из списка.
столбцов	fields		dynamic

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

Имя	Путь	Тип	Описание
URL	url_no_signup	string	Ссылка для подписывания

Удаление внедренного приглашения группы документов

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

Это действие удаляет внедренное приглашение для определенной группы документов

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор группы документов	id	True	string	Идентификатор группы документов

Удаление документа

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

Удаление документа из SignNow

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	doc_id	True	string	Указание уникального идентификатора документа

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

Имя	Путь	Тип	Описание
Состояние	status	string	Состояние удаления документа

Удаление приглашения на внедрение документов

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

Это действие удаляет внедренное приглашение для документа

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Идентификатор документа	id	True	string	Идентификатор документа

Триггеры

Запуск потока для события документа [DEPRECATED]

Это действие устарело. Вместо этого используйте начальный поток для события документа .

Вы можете создать триггер для одного из этих событий: создание документа, обновление документа, удаление документа, завершение документа, приглашение на создание, приглашение на обновление

Запуск потока событий документа

Выберите событие для активации: новое или обновленное приглашение подписи; При создании, обновлении, завершении или удалении документа

Запуск потока для события документа [DEPRECATED]

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

Это действие устарело. Вместо этого используйте начальный поток для события документа .

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Event	event	True	string	Выберите событие, которое должно активировать поток.

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

Имя	Путь	Тип	Описание
Отметка времени	meta.timestamp	integer	Дата и время возникновения события (формат метки времени Unix).
Event	meta.event	string	Событие документа, вызвавшее триггер.
Идентификатор документа	content.document_id	string	Уникальный идентификатор целевого документа, вызвавшего событие.
Имя документа	content.document_name	string	Имя целевого файла документа без расширения

Запуск потока событий документа

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

Параметры

Имя	Ключ	Обязательно	Тип	Описание
Event	event	True	string	Выберите событие, которое должно активировать поток

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

Имя	Путь	Тип	Описание
Event	meta.event	string	Событие документа, вызвавшее триггер.
Идентификатор документа	content.document_id	string	Уникальный идентификатор целевого документа, вызвавшего событие.
Имя документа	content.document_name	string	Имя целевого файла документа без расширения

Определения

DocumentProperties

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа
Имя документа	document_name	string	Имя файла документа без расширения
Количество страниц	page_count	integer	Количество страниц в документе
Создано	created	integer	Дата и время создания документа в формате метки времени Unix
Updated	updated	integer	Дата и время обновления документа в формате метки времени Unix
Имя шаблона	original_filename	string	Имя файла шаблона с расширением (если таковой есть)
ИД шаблона	origin_document_id	string	Идентификатор документа шаблона (если таковой есть)
Шаблон	template	boolean	Значение true, если документ является шаблоном.
Состояние документа	status	string	Состояние документа

DocumentGroupsResponse

Имя	Путь	Тип	Описание
document_groups	document_groups	array of DocumentGroupProperties
Общее число групп документов	document_group_total_count	integer	Общее количество групп документов в учетной записи SignNow

DocumentGroupProperties

Имя	Путь	Тип	Описание
Идентификатор группы документов	group_id	DocumentGroupId	Уникальный идентификатор группы документов
Имя группы документов	group_name	string	Имя группы документов
Documents	documents	array of DocumentGroupDocumentProperties	Documents

DocumentGroupDocumentProperties

Имя	Путь	Тип	Описание
Идентификатор документа	id	DocumentId	Уникальный идентификатор документа
Имя документа	document_name	string	Имя файла документа без расширения
ИД шаблона	origin_document_id	string	Идентификатор документа шаблона (если таковой есть)

CreateDocumentGroupFromFilesResponse

Имя	Путь	Тип	Описание
Имя группы документов	group_name	string	Имя группы документов
Идентификатор группы документов	group_id	string	Идентификатор группы документов
Документы	documents	array of object
Идентификатор документа	documents.id	DocumentId	Уникальный идентификатор документа
Имя документа	documents.name	string	Имя документа

DocumentId

Уникальный идентификатор документа

Идентификатор документа: string

DocumentGroupId

Уникальный идентификатор группы документов

Идентификатор группы документов: string

объект

Это тип object.

бинарный

Это базовый тип данных binary.