sproof Sign (preview)

Используйте sproof Sign для автоматизации безопасных рабочих процессов электронной подписи для документов PDF и DOCX. Организации могут создавать или подготавливать запросы подписи с одним или несколькими документами, назначать получателей и подписывать роли, перечислять и отслеживать документы, скачивать завершенные PDF-файлы и удалять документы. Требуется учетная запись подписи, план, поддерживающий выбранные действия и типы подписей, а также допустимый маркер API.

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

Service Class Регионы
Copilot Studio Premium Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Premium Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Premium Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Name Поддержка API
URL https://sproof.com
Эл. почта support@sproof.com
Метаданные соединителя
Publisher sproof GmbH
Веб-сайт https://www.sproof.com/en/sign/
Политика конфиденциальности https://www.sproof.com/en/privacy-policy-app/
Categories Продуктивность; Содержимое и файлы

знак sproof

Обзор

Sproof Sign позволяет организациям автоматизировать рабочие процессы электронной подписи для документов PDF и DOCX. Соединитель может создавать или подготавливать запросы подписи с одним документом или конверты с несколькими документами, назначать получателей и подписывать роли, перечислять документы, получать состояние запроса, скачивать завершенные документы и удалять документы.

Обновления в этой версии

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

Prerequisites

Чтобы использовать соединитель, вам потребуется:

  • Учетная запись для подписывания.
  • План проверки подписи с доступом к API и поддержкой необходимых действий и типов подписей.
  • Допустимый маркер API подписи.

Authentication

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

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

  • Создание запроса подписи— создает запрос на один документ или конверт, содержащий несколько документов. Получатели, роли подписывания, порядок подписи, позиции подписи и другие параметры приглашения можно настроить.
  • Создайте запрос подписи с помощью заполнителей— создает запрос с помощью заполнителей , хранящихся в отправленном документе. Сведения о получателях и позиции подписи извлекаются из этих заполнителей.
  • Подготовка запроса подписи — создает запрос подписи черновика без приглашения получателей. Возвращаемый идентификатор члена можно использовать для открытия и подготовки документа в редакторе подписей sproof.
  • Получение документов — список документов, доступных для подключенной учетной записи подписывания. Параметры разбиения на страницы, фильтрации, сортировки и поиска можно использовать для сужения результата.
  • Получение состояния запроса — извлекает текущее состояние и состояние подписи запроса подписи с помощью его идентификатора члена.
  • Получение документа — скачивание документа в виде двоичного PDF-файла или в формате PDF в кодировке Base64.
  • Удаление документа — удаляет документ или удаляет доступ члена в зависимости от предоставленного идентификатора члена, роли участника и того, принадлежит ли документ конверту.

Известные ограничения и требования

  • Входные документы должны быть предоставлены в формате PDF или DOCX в кодировке Base64.
  • Конверт может содержать не более 25 документов.
  • Имя конверта требуется при отправке нескольких документов.
  • Запросы на основе заполнителей требуют правильно отформатированных заполнителей в отправленном документе.
  • Для запросов на основе заполнителей получатели и позиции подписи получаются из документа, а не вводятся вручную.
  • Доступные действия, типы подписей и поставщики зависят от подключенной учетной записи подписи и плана.
  • Поведение удаления документов зависит от того, принадлежит ли предоставленный идентификатор участника отправителю или получателю и является ли документ частью конверта.

Поддержка

Для поддержки соединителя или API обратитесь support@sproof.comв службу поддержки.

Создание подключения

Соединитель поддерживает следующие типы проверки подлинности:

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

По умолчанию

Применимо: все регионы

Параметры для создания подключения.

Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.

Name Тип Description Обязательный
token securestring "token" für diese API True

Действия

Подготовка запроса подписи

Создает запрос подписи черновика без приглашения получателей. Используйте возвращенный идентификатор члена, чтобы открыть документ в редакторе подписей sproof.

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

Получение подписанного документа в виде двоичной строки или строки в кодировке Base64.

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

Возвращает документы, созданные владельцем маркера API (прошедшим проверку подлинности), независимо от того, были ли эти документы созданы с помощью пользовательского интерфейса или через API.

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

Получение состояния запроса

Получение состояния запроса подписи. Возвращает объект JSON документа или ошибку. Параметр возвращается запросом после отправки документа и связан с адресом электронной почты отправителей.

Создание запроса подписи

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

Создание запроса подписи с помощью заполнителей

Создает запрос подписи с помощью заполнителей, хранящихся в отправленном документе. Получатели и позиции подписи извлекаются из документа.

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

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

Документы в конверте

Параметр all запроса не влияет на документы в конверте.

С отправителем memberId:

  • Один документ удаляется для отправителя и всех получателей.
  • Документ удаляется из конверта.

С получателем memberId:

  • Все документы в конверте удаляются для получателя.
  • Получатель помечается как declined на всех документах, которые были удалены для получателя.
  • Документы остаются доступными для всех остальных членов документа.

Отдельные документы

С отправителем memberId и all=true:

  • Документ удаляется для отправителя и всех получателей.

С отправителем memberId и all=false:

  • Документ удаляется только для отправителя.
  • Документ остается доступным для других получателей документа.

С получателем memberId:

  • Получатель помечается как declined в документе.
  • Документ остается доступным для всех остальных членов документа.

Подготовка запроса подписи

Создает запрос подписи черновика без приглашения получателей. Используйте возвращенный идентификатор члена, чтобы открыть документ в редакторе подписей sproof.

Параметры

Имя Ключ Обязательно Тип Описание
email
email True string

Электронная почта отправителя. Он должен принадлежать члену вашего плана.

firstName
firstName True string

Имя отправителя.

lastName
lastName string

Фамилия отправителя.

role
role string

Роль отправителя во всех документах.

email
email string

Электронная почта получателя.

firstName
firstName string

Имя получателя.

lastName
lastName string

Фамилия получателя.

doNotSendEmails
doNotSendEmails boolean

Если задано значение true "Нет сообщения электронной почты", отправляется получателю.

customId
customId string

Используется только в том случае, если адрес электронной почты получателя неизвестен во время приглашения. Это работает только при приглашении получателей (не для подготовки маршрутов) и вы хотите использовать fastlane. Позволяет customId предварительно создать уникальную ссылку подписи для получателя перед отправкой приглашения. Должен быть уникальной буквенно-цифровой строкой не менее 70 символов.

Примечание. CustomId можно использовать только для создания ссылки получателя на документ. Его нельзя использовать для других запросов вместо объекта memberId. Дополнительные сведения о построении URL-адресов см. в разделе "Открытие документа с пользовательским идентификатором"

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

phoneNumber
phoneNumber string

Номер телефона этого получателя. Используется для проверки SMS. (например: +43 699 1234 1234).

privateMessage
privateMessage string

Частное сообщение для этого конкретного получателя.

inPersonMode
inPersonMode boolean

Если этот параметр включен, получатель запроса подписи потребуется для подписи документа лично, и сообщение электронной почты не отправляется. Этот режим доступен только с помощью типа подписи SES

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

tag
tag string

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

Примечание1. Некоторые поставщики доступны только для определенных типов подписей, например onetimeqes , потребуется "signatureType" : ["qualifiedPlusIdent"]

Примечание2. При использовании sproof-qualified в качестве поставщика по умолчанию получателю должна быть активная учетная запись sproof с активной лицензией User+.

canChange
canChange boolean

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

country
country string

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

dueDate
dueDate YYYY-MM-DD

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

напоминаниеInterval
reminderInterval number

Указывает количество дней между письмами напоминания.

startSendingReminders
startSendingReminders YYYY-MM-DD HH:MM

Дата отправки напоминаний

inviteLanguage
inviteLanguage string

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

message
message string

Настраиваемое сообщение, отправленное получателям в сообщении электронной почты.

субъект
subject string

Тема сообщения электронной почты, отправленная получателям.

sendOutFinishedPdf
sendOutFinishedPdf boolean

Если задано значение true, pdf-файл отправляется в виде вложения всем получателям документа (если оно меньше 5 МБ).

focusedSigningMode
focusedSigningMode boolean

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

allowForwarding
allowForwarding boolean

Разрешить переадресацию приглашения.

collabSigningMode
collabSigningMode object

Объект, в котором каждый ключ представляет раунд подписывания, и соответствующее значение указывает, включена ли совместная подпись для этого раунда. Если значение равно true, для завершения указанного раунда подписи требуется только одна подпись и переход к следующему раунду. Например, { '1': true} означает, что при подписи "1" требуется только одна подпись.

usePlaceholders
usePlaceholders boolean

Если значение true, заполнители текста или formFields, хранящиеся в документе, будут использоваться для приглашения получателей.

inPersonSigning
inPersonSigning boolean

Когда значение true, получатель получает всплывающее окно, в котором он должен вручную нарисовать подпись.

folderName
folderName string

Если задано, будет создан конверт, содержащий все документы в documentDataArray. (Требуется, если отправляется несколько документов)

callbackUrl
callbackUrl string

Запрос POST, включая документ, будет отправлен на этот URL-адрес при создании новой подписи или при отклонении документа получателем. В случае сбоя используется механизм повтора, чтобы убедиться, что запрос выполняется повторно.

returnUrl
returnUrl string

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

returnBtnText
returnBtnText string

Текст кнопки возврата после подписания документа

Данные
data True string

Данные документа (PDF или DOCX) в формате base64.

mimetype
mimetype string

Тип MIME в кодировке Base64 data PDF или DOCX, обязательный, если документ не является pdf-файлом

Имя файла
fileName True string

Имя файла

label
label string

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

страница
page True integer

Номер страницы, на которой находится поле, с первой страницей 0.

pageWidth
pageWidth number

Любое целочисленное значение, описывающее ширину страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 478.

pageHeight
pageHeight number

Любое целочисленное значение, описывающее высоту страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 676.

x
x True float

Представляет горизонтальную позицию поля в процентах от ширины страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% ширины страницы слева.

и
y True float

Представляет вертикальную позицию поля в процентах от высоты страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% высоты страницы сверху.

width
width True float

Ширина поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыWidth.

height
height True float

Высота поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыHeight.

id
id True string

Уникальный идентификатор для этого поля, созданный любым способом.

label
label string

Текст заполнителя, например имя поля, например "Дата рождения".

value
value string

Значение по умолчанию для поля. Может иметь значение NULL. Если поле имеет тип "chooseBox", значение может иметь значение NULL или одну из строк, определенных в параметрах.

Идентификатор поля
fieldId string

Стабильный идентификатор поля, настроенный в пользовательском интерфейсе. Используется для предварительной заполнения полей формы рабочего процесса с помощью запросов API.

Только для чтения
readonly boolean

Если задано значение true, приглашенный пользователь не может изменить значение этого поля.

required
required boolean

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

type
type True string
многостроочное
multiline boolean

Разрешено ли несколько строк.

displayValue
displayValue True string
exportValue
exportValue True string
group
group number

Каждое радио поле может быть назначено группе.

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого документа, может быть перезаписан типом подписи получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "квалифицированный", "простой", "квалифицированныйPlusIdent"

refId
refId string

RefId — это необязательное поле, используемое для перекрестной ссылки на отправленный документ. Если он указан, он позволяет назначить пользовательский идентификатор ссылки документу, который будет возвращен как часть объекта документа в будущих ответах API. Это может быть полезно для отслеживания или организации документов внешними системами или рабочим процессом.

language
language string

Язык документа.

folderId
folderId string

Идентификатор папки, в которую должны вставляться документы. Это возможно только в том случае, если не определено как inviteData, так и folderName.

isAttachment
isAttachment boolean

IsAttachment не требуется в этом случае.

Сведения о получателе
recipientDetails True object

Сведения о получателе, указанные в сообщении электронной почты получателя. Пример: {"mail@test.com:"{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}}

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

fastlaneProfileId
fastlaneProfileId uuid

Укажите профиль Fastlane, который следует использовать с этим документом. (параметр useFastlane должен иметь значение true).

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

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

Получение подписанного документа в виде двоичной строки или строки в кодировке Base64.

Параметры

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

Идентификатор члена

Формат скачивания
format string

Задает формат ответа. Используется pdf для двоичного PDF-файла и base64 для ответа в кодировке Base64. Пример base64 ответа: json { "base64": "JVBERi0xLjQKJe..." }

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

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

Содержимое PDF в кодировке Base64

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

Возвращает документы, созданные владельцем маркера API (прошедшим проверку подлинности), независимо от того, были ли эти документы созданы с помощью пользовательского интерфейса или через API.

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

Параметры

Имя Ключ Обязательно Тип Описание
Записи на страницу
perPage integer

Укажите количество записей на страницу.

Номер страницы
page integer

Укажите номер страницы.

Фильтр документов
view string

Укажите фильтр документов.

Сортировка документов
sort string

Сортировка документов. Добавьте значение ":true" для сортировки по убыванию.

Поисковый запрос
query string

Поиск различных сведений.

Поведение:

  • Как правило, без учета регистра
  • Одно слово или фраза с кавычками (например, "Квартальный отчет") выполняет сопоставление подстроки
  • Несколько слов, разделенных пробелами (например, квартальный отчет Q1), должны соответствовать всем подстрокам (И условию)
  • Поля поиска: имя документа, сообщения электронной почты участника, имена участников и фамилии, имя папки
  • Подстановочные знаки или regex не поддерживаются
  • Если внутренний индекс поиска еще не обновлен, выполняется поиск только имени документа.
Фильтр меток
labels string

Фильтрация документов по имени метки.

Создано из
startDate date-time

Фильтрует результаты, начиная с определенной даты и времени создания в формате UTC (не фильтруется по обновлению). Используйте этот параметр в сочетании с endDate, чтобы определить диапазон времени.

Создание до
endDate date-time

Фильтрует результаты, заканчивающиеся определенной датой и временем создания в формате UTC (не фильтруется по обновлению). Используйте этот параметр в сочетании с startDate, чтобы определить диапазон времени.

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

Объект ответа для операций списка документов

Ответ списка документов
_DocumentListResponse

Получение состояния запроса

Получение состояния запроса подписи. Возвращает объект JSON документа или ошибку. Параметр возвращается запросом после отправки документа и связан с адресом электронной почты отправителей.

Параметры

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

Идентификатор члена

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

Создание запроса подписи

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

Параметры

Имя Ключ Обязательно Тип Описание
email
email True string

Электронная почта отправителя. Он должен принадлежать члену вашего плана.

firstName
firstName True string

Имя отправителя.

lastName
lastName string

Фамилия отправителя.

role
role string

Роль отправителя во всех документах.

email
email string

Электронная почта получателя.

firstName
firstName string

Имя получателя.

lastName
lastName string

Фамилия получателя.

doNotSendEmails
doNotSendEmails boolean

Если задано значение true "Нет сообщения электронной почты", отправляется получателю.

customId
customId string

Используется только в том случае, если адрес электронной почты получателя неизвестен во время приглашения. Это работает только при приглашении получателей (не для подготовки маршрутов) и вы хотите использовать fastlane. Позволяет customId предварительно создать уникальную ссылку подписи для получателя перед отправкой приглашения. Должен быть уникальной буквенно-цифровой строкой не менее 70 символов.

Примечание. CustomId можно использовать только для создания ссылки получателя на документ. Его нельзя использовать для других запросов вместо объекта memberId. Дополнительные сведения о построении URL-адресов см. в разделе "Открытие документа с пользовательским идентификатором"

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

phoneNumber
phoneNumber string

Номер телефона этого получателя. Используется для проверки SMS. (например: +43 699 1234 1234).

privateMessage
privateMessage string

Частное сообщение для этого конкретного получателя.

inPersonMode
inPersonMode boolean

Если этот параметр включен, получатель запроса подписи потребуется для подписи документа лично, и сообщение электронной почты не отправляется. Этот режим доступен только с помощью типа подписи SES

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

tag
tag string

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

Примечание1. Некоторые поставщики доступны только для определенных типов подписей, например onetimeqes , потребуется "signatureType" : ["qualifiedPlusIdent"]

Примечание2. При использовании sproof-qualified в качестве поставщика по умолчанию получателю должна быть активная учетная запись sproof с активной лицензией User+.

canChange
canChange boolean

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

country
country string

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

dueDate
dueDate YYYY-MM-DD

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

напоминаниеInterval
reminderInterval number

Указывает количество дней между письмами напоминания.

startSendingReminders
startSendingReminders YYYY-MM-DD HH:MM

Дата отправки напоминаний

inviteLanguage
inviteLanguage string

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

message
message string

Настраиваемое сообщение, отправленное получателям в сообщении электронной почты.

субъект
subject string

Тема сообщения электронной почты, отправленная получателям.

sendOutFinishedPdf
sendOutFinishedPdf boolean

Если задано значение true, pdf-файл отправляется в виде вложения всем получателям документа (если оно меньше 5 МБ).

focusedSigningMode
focusedSigningMode boolean

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

allowForwarding
allowForwarding boolean

Разрешить переадресацию приглашения.

collabSigningMode
collabSigningMode object

Объект, в котором каждый ключ представляет раунд подписывания, и соответствующее значение указывает, включена ли совместная подпись для этого раунда. Если значение равно true, для завершения указанного раунда подписи требуется только одна подпись и переход к следующему раунду. Например, { '1': true} означает, что при подписи "1" требуется только одна подпись.

usePlaceholders
usePlaceholders boolean

Если значение true, заполнители текста или formFields, хранящиеся в документе, будут использоваться для приглашения получателей.

inPersonSigning
inPersonSigning boolean

Когда значение true, получатель получает всплывающее окно, в котором он должен вручную нарисовать подпись.

folderName
folderName string

Если задано, будет создан конверт, содержащий все документы в documentDataArray. (Требуется, если отправляется несколько документов)

callbackUrl
callbackUrl string

Запрос POST, включая документ, будет отправлен на этот URL-адрес при создании новой подписи или при отклонении документа получателем. В случае сбоя используется механизм повтора, чтобы убедиться, что запрос выполняется повторно.

returnUrl
returnUrl string

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

returnBtnText
returnBtnText string

Текст кнопки возврата после подписания документа

Данные
data True string

Данные документа (PDF или DOCX) в формате base64.

mimetype
mimetype string

Тип MIME в кодировке Base64 data PDF или DOCX, обязательный, если документ не является pdf-файлом

Имя файла
fileName True string

Имя файла

label
label string

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

страница
page True integer

Номер страницы, на которой находится поле, с первой страницей 0.

pageWidth
pageWidth number

Любое целочисленное значение, описывающее ширину страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 478.

pageHeight
pageHeight number

Любое целочисленное значение, описывающее высоту страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 676.

x
x True float

Представляет горизонтальную позицию поля в процентах от ширины страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% ширины страницы слева.

и
y True float

Представляет вертикальную позицию поля в процентах от высоты страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% высоты страницы сверху.

width
width True float

Ширина поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыWidth.

height
height True float

Высота поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыHeight.

id
id True string

Уникальный идентификатор для этого поля, созданный любым способом.

label
label string

Текст заполнителя, например имя поля, например "Дата рождения".

value
value string

Значение по умолчанию для поля. Может иметь значение NULL. Если поле имеет тип "chooseBox", значение может иметь значение NULL или одну из строк, определенных в параметрах.

Идентификатор поля
fieldId string

Стабильный идентификатор поля, настроенный в пользовательском интерфейсе. Используется для предварительной заполнения полей формы рабочего процесса с помощью запросов API.

Только для чтения
readonly boolean

Если задано значение true, приглашенный пользователь не может изменить значение этого поля.

required
required boolean

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

type
type True string
многостроочное
multiline boolean

Разрешено ли несколько строк.

displayValue
displayValue True string
exportValue
exportValue True string
group
group number

Каждое радио поле может быть назначено группе.

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого документа, может быть перезаписан типом подписи получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "квалифицированный", "простой", "квалифицированныйPlusIdent"

refId
refId string

RefId — это необязательное поле, используемое для перекрестной ссылки на отправленный документ. Если он указан, он позволяет назначить пользовательский идентификатор ссылки документу, который будет возвращен как часть объекта документа в будущих ответах API. Это может быть полезно для отслеживания или организации документов внешними системами или рабочим процессом.

language
language string

Язык документа.

folderId
folderId string

Идентификатор папки, в которую должны вставляться документы. Это возможно только в том случае, если не определено как inviteData, так и folderName.

isAttachment
isAttachment boolean

IsAttachment не требуется в этом случае.

Сведения о получателе
recipientDetails True object

Сведения о получателе, указанные в сообщении электронной почты получателя. Пример: {"mail@test.com:"{"role":"signer","signaturePositions":[{"page":0,"x":0.55,"y":0.80,"width":0.25,"height":0.08}}

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

fastlaneProfileId
fastlaneProfileId uuid

Укажите профиль Fastlane, который следует использовать с этим документом. (параметр useFastlane должен иметь значение true).

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

Тело
EnvelopeResponse

Создание запроса подписи с помощью заполнителей

Создает запрос подписи с помощью заполнителей, хранящихся в отправленном документе. Получатели и позиции подписи извлекаются из документа.

Параметры

Имя Ключ Обязательно Тип Описание
email
email True string

Электронная почта отправителя. Он должен принадлежать члену вашего плана.

firstName
firstName True string

Имя отправителя.

lastName
lastName string

Фамилия отправителя.

role
role string

Роль отправителя во всех документах.

email
email string

Электронная почта получателя.

firstName
firstName string

Имя получателя.

lastName
lastName string

Фамилия получателя.

doNotSendEmails
doNotSendEmails boolean

Если задано значение true "Нет сообщения электронной почты", отправляется получателю.

customId
customId string

Используется только в том случае, если адрес электронной почты получателя неизвестен во время приглашения. Это работает только при приглашении получателей (не для подготовки маршрутов) и вы хотите использовать fastlane. Позволяет customId предварительно создать уникальную ссылку подписи для получателя перед отправкой приглашения. Должен быть уникальной буквенно-цифровой строкой не менее 70 символов.

Примечание. CustomId можно использовать только для создания ссылки получателя на документ. Его нельзя использовать для других запросов вместо объекта memberId. Дополнительные сведения о построении URL-адресов см. в разделе "Открытие документа с пользовательским идентификатором"

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

phoneNumber
phoneNumber string

Номер телефона этого получателя. Используется для проверки SMS. (например: +43 699 1234 1234).

privateMessage
privateMessage string

Частное сообщение для этого конкретного получателя.

inPersonMode
inPersonMode boolean

Если этот параметр включен, получатель запроса подписи потребуется для подписи документа лично, и сообщение электронной почты не отправляется. Этот режим доступен только с помощью типа подписи SES

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "qualified", "qualifiedPlusIdent", "simple"

tag
tag string

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

Примечание1. Некоторые поставщики доступны только для определенных типов подписей, например onetimeqes , потребуется "signatureType" : ["qualifiedPlusIdent"]

Примечание2. При использовании sproof-qualified в качестве поставщика по умолчанию получателю должна быть активная учетная запись sproof с активной лицензией User+.

canChange
canChange boolean

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

country
country string

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

dueDate
dueDate YYYY-MM-DD

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

напоминаниеInterval
reminderInterval number

Указывает количество дней между письмами напоминания.

startSendingReminders
startSendingReminders YYYY-MM-DD HH:MM

Дата отправки напоминаний

inviteLanguage
inviteLanguage string

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

message
message string

Настраиваемое сообщение, отправленное получателям в сообщении электронной почты.

субъект
subject string

Тема сообщения электронной почты, отправленная получателям.

sendOutFinishedPdf
sendOutFinishedPdf boolean

Если задано значение true, pdf-файл отправляется в виде вложения всем получателям документа (если оно меньше 5 МБ).

focusedSigningMode
focusedSigningMode boolean

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

allowForwarding
allowForwarding boolean

Разрешить переадресацию приглашения.

collabSigningMode
collabSigningMode object

Объект, в котором каждый ключ представляет раунд подписывания, и соответствующее значение указывает, включена ли совместная подпись для этого раунда. Если значение равно true, для завершения указанного раунда подписи требуется только одна подпись и переход к следующему раунду. Например, { '1': true} означает, что при подписи "1" требуется только одна подпись.

inPersonSigning
inPersonSigning boolean

Когда значение true, получатель получает всплывающее окно, в котором он должен вручную нарисовать подпись.

folderName
folderName string

Если задано, будет создан конверт, содержащий все документы в documentDataArray. (Требуется, если отправляется несколько документов)

callbackUrl
callbackUrl string

Запрос POST, включая документ, будет отправлен на этот URL-адрес при создании новой подписи или при отклонении документа получателем. В случае сбоя используется механизм повтора, чтобы убедиться, что запрос выполняется повторно.

returnUrl
returnUrl string

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

returnBtnText
returnBtnText string

Текст кнопки возврата после подписания документа

Данные
data True string

Данные документа (PDF или DOCX) в формате base64.

mimetype
mimetype string

Тип MIME в кодировке Base64 data PDF или DOCX, обязательный, если документ не является pdf-файлом

Имя файла
fileName True string

Имя файла

label
label string

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

страница
page True integer

Номер страницы, на которой находится поле, с первой страницей 0.

pageWidth
pageWidth number

Любое целочисленное значение, описывающее ширину страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 478.

pageHeight
pageHeight number

Любое целочисленное значение, описывающее высоту страницы. Чем больше число, тем лучше точность при расположении поля в пространстве x y. На странице A4 в качестве значения по умолчанию у нас есть 676.

x
x True float

Представляет горизонтальную позицию поля в процентах от ширины страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% ширины страницы слева.

и
y True float

Представляет вертикальную позицию поля в процентах от высоты страницы. Источник (0,0) находится в левом верхнем углу страницы. Значение 0,1 означает, что поле размещается в 10% высоты страницы сверху.

width
width True float

Ширина поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыWidth.

height
height True float

Высота поля на основе измерений страницы, аналогичных координатам x и y. Это плавающая строка, представляющая процент страницыHeight.

id
id True string

Уникальный идентификатор для этого поля, созданный любым способом.

label
label string

Текст заполнителя, например имя поля, например "Дата рождения".

value
value string

Значение по умолчанию для поля. Может иметь значение NULL. Если поле имеет тип "chooseBox", значение может иметь значение NULL или одну из строк, определенных в параметрах.

Идентификатор поля
fieldId string

Стабильный идентификатор поля, настроенный в пользовательском интерфейсе. Используется для предварительной заполнения полей формы рабочего процесса с помощью запросов API.

Только для чтения
readonly boolean

Если задано значение true, приглашенный пользователь не может изменить значение этого поля.

required
required boolean

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

type
type True string
многостроочное
multiline boolean

Разрешено ли несколько строк.

displayValue
displayValue True string
exportValue
exportValue True string
group
group number

Каждое радио поле может быть назначено группе.

signatureTypes
signatureTypes array of string

Тип подписи, разрешенный для этого документа, может быть перезаписан типом подписи получателя. Не более одного значения поддерживается. Параметры: "advanced", "advancedPlus", "квалифицированный", "простой", "квалифицированныйPlusIdent"

refId
refId string

RefId — это необязательное поле, используемое для перекрестной ссылки на отправленный документ. Если он указан, он позволяет назначить пользовательский идентификатор ссылки документу, который будет возвращен как часть объекта документа в будущих ответах API. Это может быть полезно для отслеживания или организации документов внешними системами или рабочим процессом.

language
language string

Язык документа.

folderId
folderId string

Идентификатор папки, в которую должны вставляться документы. Это возможно только в том случае, если не определено как inviteData, так и folderName.

isAttachment
isAttachment boolean

IsAttachment не требуется в этом случае.

useFastlane
useFastlane boolean

Если задано значение true для подписывчика, в сообщении приглашения появится ссылка Fastlane.

fastlaneProfileId
fastlaneProfileId uuid

Укажите профиль Fastlane, который следует использовать с этим документом. (параметр useFastlane должен иметь значение true).

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

Тело
EnvelopeResponse

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

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

Документы в конверте

Параметр all запроса не влияет на документы в конверте.

С отправителем memberId:

  • Один документ удаляется для отправителя и всех получателей.
  • Документ удаляется из конверта.

С получателем memberId:

  • Все документы в конверте удаляются для получателя.
  • Получатель помечается как declined на всех документах, которые были удалены для получателя.
  • Документы остаются доступными для всех остальных членов документа.

Отдельные документы

С отправителем memberId и all=true:

  • Документ удаляется для отправителя и всех получателей.

С отправителем memberId и all=false:

  • Документ удаляется только для отправителя.
  • Документ остается доступным для других получателей документа.

С получателем memberId:

  • Получатель помечается как declined в документе.
  • Документ остается доступным для всех остальных членов документа.

Параметры

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

Идентификатор члена

Удаление для всех получателей
all boolean

Относится только к отдельным документам, если указанный memberId объект принадлежит отправителю. Если задано значение true, документ удаляется для отправителя и всех получателей. Если задано значение false, документ удаляется только для отправителя и остается доступным для других получателей. Этот параметр не влияет на документы в конверте (по умолчанию = true) или когда указанный memberId параметр принадлежит получателю.

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

Определения

DeleteDocumentResponse

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

_DocumentListResponse

Объект ответа для операций списка документов

Имя Путь Тип Описание
Данные
data array of _Document

Список документов

Объект разбиения на страницы
pagination _PaginationObject

_PaginationObject

Имя Путь Тип Описание
total
total integer

Общее количество элементов (например, документов) в представлении (например, allDocuments)

lastPage
lastPage integer

Номер последней страницы

perPage
perPage integer

Количество документов на страницу

currentPage
currentPage integer

Номер текущей страницы

до
to integer

Индекс последнего документа

_Document

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

Название документа

id
id string

Код документа

обновлено в
updatedAt date

Дата последнего обновления документа

createdAt
createdAt date

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

signaturesTypes
signaturesTypes array of string

Типы подписей, разрешенные для этого получателя, могут быть перезаписаны типами подписей получателей. Параметры: ['advanced', 'advancedPlus', 'qualified', 'simple','qualifiedPlusIdent']

callbackUrl
callbackUrl string

Запрос на публикацию, включая документ, будет отправлен в этот URL-адрес при создании новой подписи.

returnUrl
returnUrl string

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

returnBtnText
returnBtnText string

Текст кнопки возврата после подписания документа

inPersonSigning
inPersonSigning boolean
подписывание
signingRound number
state
state string

Текущее состояние документа. Возможные значения: черновик, ожидание, отклонение, завершено, вложение, вручнуюPending, вручнуюCompleted

член
member

Как правило, владелец документа, но если вы используете getSignatureStatus, участник будет участником, который указан в запросе.

members
members array of DocumentListMember

Список приглашенных контактов

Коробки
boxes array of DocumentListResponseBox

Данные позиции подписи с дополнительными полями ответа. Поля cardStyle, pageWidth и pageHeight являются необязательными и могут не присутствовать во всех ответах API.

refId
refId string
allSignersSignersSigned
allSignersSigned boolean
allMembersSigned
allMembersSigned boolean
focusedSigningMode
focusedSigningMode boolean

DocumentListResponseBox

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

Настроенный идентификатор поля, используемый для предварительной заполнения полей формы. Возвращает значение NULL, если идентификатор поля не настроен.

type
type string
value
value

Значение поля поля. Может быть строка (включая пустую строку), логическое значение или значение NULL в зависимости от типа поля.

label
label string
readOnly
readOnly boolean

DocumentListMember

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

Идентификатор члена можно использовать для открытия документа в редакторе подписей sproof. Более подробное описание можно найти здесь

email
email string

Электронная почта владельца документа

firstName
firstName string

Имя владельца документа

lastName
lastName string

Фамилия владельца документа

lastActivityAt
lastActivityAt date-time

Дата и время последнего действия (строка даты и времени ISO 8601)

createdAt
createdAt date-time

Дата и время отправки документа (строка даты и времени ISO 8601)

подписанный
signed boolean

Указывает, был ли документ подписан владельцем

isAdmin
isAdmin boolean

Указывает, имеет ли член состояние администратора

isSigner
isSigner boolean

Указывает, является ли элемент подписывателем

isApprover
isApprover boolean

Указывает, является ли участник утверждающий

isViewer
isViewer boolean

Указывает, является ли элемент средством просмотра

утверждено
approvedAt date-time

Только если isApprover имеет значение true. Дата и время утверждения члена (строка даты и времени ISO 8601)

viewedAt
viewedAt date-time

Только если isViewer имеет значение true. Дата и время просмотра документа (строка даты и времени ISO 8601)

сигнатура
signaturePosition

Позиции подписи для этого элемента. На основе того, что отправляется в запросе, можно ожидать либо один объект позиции, либо массив объектов позиций.

signedAt
signedAt date-time

Дата и время подписи (строка даты и времени ISO 8601)

подписываниеOrder
signingOrder number

Порядок, в котором этот член должен подписаться

отклонить
declinedAt date-time

Дата и время отклонить член (строка даты и времени ISO 8601)

Подписи
signatures array of object

Массив подписей

signatureType
signatures.signatureType string

Тип подписи (например, aes_sproof)

signedAt
signatures.signedAt date-time

Метка времени применения подписи (строка даты и времени ISO 8601)

PrepareSignatureRequestResponse

Имя Путь Тип Описание
folderId
folderId string
folderName
folderName string
Документы
documents array of object
id
documents.id string
имя
documents.name string
language
documents.language string
members
documents.members array of

Так как это ответ запроса на подготовку подписи, массив элементов будет пустым. Это связано с тем, что участники еще не приглашены.

член
documents.member MemberResponseSchema

MemberResponseSchema

Имя Путь Тип Описание
id
id string
documentId
documentId string
email
email string
firstName
firstName string
lastName
lastName string
isAdmin
isAdmin boolean
createdAt
createdAt date-time

Дата и время создания элемента (строка даты и времени ISO 8601)

sentDeleteNotificationAt
sentDeleteNotificationAt date-time

Дата и время отправки уведомления об удалении (строка даты и времени ISO 8601)

вручнуюLastEmailSent
manuallyLastEmailSent date-time

Дата и время отправки последней электронной почты вручную (строка даты и времени ISO 8601)

сигнатура
signaturePosition MemberSignaturePositionResponse

Данные позиции подписи с дополнительными полями ответа. Поля cardStyle, pageWidth и pageHeight являются необязательными и могут не присутствовать во всех ответах API.

doNotSendEmails
doNotSendEmails boolean
отклонить
declinedAt date-time

Дата и время отклонить член (строка даты и времени ISO 8601)

подписываниеOrder
signingOrder number
Ondemand
onDemand string
recipientId
recipientId string
signatureTypes
signatureTypes array of string
signatureTypesActive
signatureTypesActive boolean
privateMessage
privateMessage string
customId
customId string
useFastlane
useFastlane boolean
role
role string
утверждено
approvedAt date-time

Дата и время утверждения члена (строка даты и времени ISO 8601)

верификацияКонфиг
verificationConfig
phoneNumber
phoneNumber string
Подписи
signatures array of string
Коробки
boxes array of DocumentResponseBox

Поля полей формы, назначенные этому элементу.

signedAt
signedAt date-time

Дата и время подписания члена (строка даты и времени ISO 8601)

DocumentResponseBox

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

Настроенный идентификатор поля, используемый для предварительной заполнения полей формы. Возвращает значение NULL, если идентификатор поля не настроен.

type
type string
value
value string

Значение поля поля. Может быть строка (включая пустую строку), логическое значение или значение NULL в зависимости от типа поля.

label
label string
readOnly
readOnly boolean

MemberSignaturePositionResponse

Данные позиции подписи с дополнительными полями ответа. Поля cardStyle, pageWidth и pageHeight являются необязательными и могут не присутствовать во всех ответах API.

Имя Путь Тип Описание
Товары
SignaturePositionResponse

Данные позиции подписи с дополнительными полями ответа. Поля cardStyle, pageWidth и pageHeight являются необязательными и могут не присутствовать во всех ответах API.

SignaturePositionResponse

Данные позиции подписи с дополнительными полями ответа. Поля cardStyle, pageWidth и pageHeight являются необязательными и могут не присутствовать во всех ответах API.

Имя Путь Тип Описание
страница
page integer

Номер страницы, начиная с 0.

x
x number

Координата x верхнего левого положения подписей

и
y number

Координата координаты верхнего левого положения подписей

width
width number

Ширина подписи.

height
height number

Высота подписи.

cardStyle
cardStyle string

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

pageWidth
pageWidth number

Ширина страницы в пикселях. Это поле является необязательным и может не возвращаться во всех ответах.

pageHeight
pageHeight number

Высота страницы в пикселях. Это поле является необязательным и может не возвращаться во всех ответах.

КонвертResponse

Имя Путь Тип Описание
folderId
folderId string
folderName
folderName string
Документы
documents array of object
id
documents.id string
имя
documents.name string
language
documents.language string
startSendingReminders
documents.startSendingReminders date-time

Дата и время начала отправки напоминаний (строка даты и времени ISO 8601)

sendReminder
documents.sendReminder boolean
напоминания
documents.reminderSent boolean
напоминаниеInterval
documents.reminderInterval number
createdAt
documents.createdAt date-time

Дата и время создания документа (строка даты и времени ISO 8601)

callbackUrl
documents.callbackUrl string
returnUrl
documents.returnUrl string
returnBtnText
documents.returnBtnText string
inPersonSigning
documents.inPersonSigning boolean
подписывание
documents.signingRound number
isTemplate
documents.isTemplate boolean
templateId
documents.templateId string
linkId
documents.linkId string
linkExpiresAt
documents.linkExpiresAt string
derivedFromLink
documents.derivedFromLink boolean
state
documents.state string
complianceLevel
documents.complianceLevel string
allowForwarding
documents.allowForwarding boolean
linkExpires
documents.linkExpires boolean
setDueDate
documents.setDueDate boolean
dueDate
documents.dueDate date-time

Дата выполнения документа (строка даты и времени ISO 8601)

focusedSigningMode
documents.focusedSigningMode boolean
linkMaxSignaturesEnabled
documents.linkMaxSignaturesEnabled boolean
linkMaxSignatures
documents.linkMaxSignatures number
fastlaneProfileId
documents.fastlaneProfileId string
refId
documents.refId string
sendOutFinishedPdf
documents.sendOutFinishedPdf boolean
signatureTypes
documents.signatureTypes array of string
members
documents.members array of MemberResponseSchema
член
documents.member MemberResponseSchema
Коробки
documents.boxes array of DocumentResponseBox

Поля общего поля формы, которые не назначены конкретному получателю, возвращаются, если в документе есть поля формы. Поля, назначенные получателям, возвращаются в элементах[n].boxes.

Просроченные
documents.overdue boolean

DocumentStatusForFlow

Имя Путь Тип Описание
id
id string
имя
name string
state
state string

Текущее состояние документа. Возможные значения: черновик, ожидание, отклонение, завершено, вложение, вручнуюPending, вручнуюCompleted

createdAt
createdAt date
обновлено в
updatedAt date
allSignersSignersSigned
allSignersSigned boolean
allMembersSigned
allMembersSigned boolean
focusedSigningMode
focusedSigningMode boolean