Legalesign (предварительная версия)
Предназначено для групп по обеспечению соответствия требованиям для юридических и операционных групп, соединитель Legalesign связывает платформу Microsoft power с legalesign eSignature для активации рабочих процессов документов и получателей, отправки напоминаний, получения PDF-файлов и данных формы поверхности. Требуется активная подписка Legalesign, утвержденная для использования API.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | поддержка API |
| URL | https://legalesign.com/contact/ |
| Адрес электронной почты | sales@legalesign.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Legalesign |
| Узнайте больше о Legalesign | https://docs.microsoft.com/connectors/legalesign |
| Сайт | https://legalesign.com |
| Политика конфиденциальности | https://legalesign.com/opn/privacy/ |
| Категории | Содержимое и файлы; Продуктивность |
Соединитель REST для legalesign eSignature
REST API Legalesign управляет рабочими процессами eSignature. Этот соединитель предоставляет полный доступ к API и триггеры в режиме реального времени, позволяя легко интегрироваться с Microsoft Power Automate, Logic Apps и связанными платформами.
Предпосылки
Чтобы приступить к работе, вам нужна учетная запись Legalesign и ключ API: 1. Зарегистрируйтесь для получения бесплатной пробной версии. 2. Создайте группу (отдельную среду, например одну для разработки и другую для рабочей среды). 3. Запросите ключ API, создав запрос в службу поддержки. Включите вариант использования, компанию и роль, чтобы поддержка удостоверяла вашу личность. 4. После проверки войдите на панель мониторинга API , чтобы получить ключ.
Развертывание
Новые учетные записи начинаются в режиме песочницы со следующими ограничениями: • Документы можно отправлять только на тестовые адреса электронной почты, настроенные на панели мониторинга API. • Запросы регулируются до 100/минут.
Когда вы будете готовы жить, создайте запрос в службу поддержки для переключения учетной записи из песочницы в рабочую среду. На этом этапе ограничения будут отменены. Дополнительные сведения см. в руководстве по развертыванию .
Triggers
Соединитель поддерживает два триггера в режиме реального времени:
- События документа (например, созданные, отклоненные, подписанные, окончательные созданные PDF-файлы)
- События получателя (например, завершенные, отклоненные, открытые сообщения электронной почты, отскочили, напоминания, отправленные)
Вы можете получать все документы или получатели, отфильтрованные по группам или типам событий. Все связанные веб-перехватчики Legalesign можно управлять и отслеживать на панели мониторинга API.
Operations
Поддерживаются операции REST API legalesign. Наиболее распространенными являются скачивание подписанного PDF-файла, управление шаблонами, документами, получателями и размещением полей. См. полную документацию по API для полной спецификации.
В Legalesign отправленный документ называется шаблоном. Когда шаблон отправляется одному или нескольким получателям, он становится документом. Обычно вы отправите шаблон, восстановите его идентификатор, а затем отправите его одному или нескольким получателям.
К общим операциям относятся:
Шаблоны
-
Create PDF template— отправка шаблона (любой тип файла, например PDF, Word или изображение). -
Get PDF embeddable link— ссылка с одним использованием для отображения редактора шаблонов пользователю
Documents
-
Location to download PDF— возвращает двоичный файл PDF подписанного документа. -
Create signing document— отправка документа (выбор шаблона и получателей) -
Void/archive signing document— остановка подписи документа -
Permanently delete signing document— удаление документа навсегда
Получатели (подписыватели)
-
Send signer reminder email— напомнить получателю о завершении документа -
Get signer rejection reason— если документ отклонен, см. причину
Размещение полей
Legalesign имеет расширенную систему форм с полями. Если у вас есть подписи, то у каждой подписи должно быть по крайней мере одно поле подписи.
Существует четыре способа определения полей в шаблоне:
- Отправьте PDF-файл со встроенными полями (автоматически преобразованы с помощью Legalesign).
- Используйте текстовые теги Legalesign.
- Определите координаты x/y.
- Используйте редактор форм Legalesign (с помощью ссылки внедрения или веб-приложения).
Щелкните здесь для руководства
Запросы и поддержка
Для получения дополнительной поддержки или запросов войдите в учетную запись Legalesign и создайте запрос в службу поддержки.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| ключ API | securestring | Api_key для этого API | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Окончательное удаление документа |
Безвозвратно удаляет данные и файлы. |
| Отправка вложения PDF |
Сохраните pdf-файл для присоединения к электронной почте получателя. |
| Отправка документа |
Отправьте документ для подписи или утверждения. |
| Отправка сообщения электронной почты с напоминанием получателя |
Отправьте получателю сообщение электронной почты с напоминанием. |
| Отправка шаблона PDF |
Отправьте PDF-документ, который нужно отправить для подписи. |
| Получение вложений |
Вывод списка вложений. |
| Получение вложения |
Получение вложения. |
| Получение групп |
Список групп, к которому принадлежит пользователь API. |
| Получение документа |
Возвращает определенный документ. |
| Получение документов |
Вывод списка неархивированных документов подписывания. |
| Получение полей документа |
Поля из документа. |
| Получение полей формы получателя |
Возвращает поля формы из определенного получателя. |
| Получение получателя |
Получение состояния и сведений об отдельном получателе. |
| Получение пользователя |
Получение сведений о пользователе. |
| Получение причины отклонения получателя |
Возвращает причину, заданную для отклонения документа. |
| Получение ссылки получателя |
Ссылка с одним использованием для получателя для перехода на страницы подписывания. |
| Получение шаблона PDF |
Сведения о конкретном шаблоне PDF |
| Получение шаблонов PDF |
Вывод списка шаблонов PDF |
| Получить ссылку для внедрения PDF |
Верните ссылку с одним использованием для внедрения редактора PDF. |
| Пустотный и архивный документ |
Задает документ с состоянием 40 удален и архивирует его. |
| Скачать PDF |
Получите черновик или окончательный PDF-файл для документа подписывания в зависимости от его состояния. Обратите внимание, что возможно ответ 200 или 302. |
| Скачивание журнала аудита документов |
PDF-файл только журнала аудита документов. |
| Удаление вложения |
Удаление вложения. |
| Член группы |
Сведения о конкретном пользователе внутри группы. |
| Члены групп |
Перечисления всех участников групп. |
Окончательное удаление документа
Безвозвратно удаляет данные и файлы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
Отправка вложения PDF
Сохраните pdf-файл для присоединения к электронной почте получателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
group
|
group | True | string |
Универсальный код ресурса группы |
|
pdf_file
|
pdf_file | True | byte |
Данные PDF-файла в кодировке Base64, максимальный размер — это параметр группы, 5 МБ по умолчанию. |
|
filename
|
filename | True | string |
Простое буквенно-цифровое имя, заканчивающееся .pdf |
|
Пользователь
|
user | string |
Назначьте другому пользователю. |
|
|
описание
|
description | string |
Отправка документа
Отправьте документ для подписи или утверждения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Группа
|
group | True | string |
Универсальный код ресурса группы |
|
Имя
|
name | True | string |
Укажите имя документа |
|
Шаблон PDF
|
templatepdf | True | string |
Отправленный PDF-файл для отправки. |
|
электронная почта
|
True |
Адрес электронной почты |
||
|
первое имя
|
firstname | True | string |
Имя (первое имя) |
|
фамилия
|
lastname | True | string |
Фамилия |
|
attachments
|
attachments | array of string |
Список uri ресурса вложения. |
|
|
Истекает
|
expires | date-time |
ISO8601 сформированное время даты и времени, задайте значение TZ отправителя или часового пояса, если используется |
|
|
сообщение
|
message | string |
Ваше личное сообщение для стороны, введенное в центре шаблона электронной почты группы. Используйте имя сохраненного шаблона электронной почты, предварительно заданного хэш-символом, чтобы использовать этот шаблон. Если имеется несколько шаблонов с тем же именем, он выберет один последний изменен. |
|
|
первое имя
|
firstname | string |
Имя (первое имя) |
|
|
фамилия
|
lastname | string |
Фамилия |
|
|
электронная почта
|
True |
Адрес электронной почты |
||
|
include_link
|
include_link | boolean |
Включите ссылку на страницы подписывания, позволяющие рецензенту подписать |
|
|
СМС
|
sms | string |
Используйте номер международного формата для добавления проверки SMS. Требуется, если свидетель или следящий подписыватель. |
|
|
субъект
|
subject | string |
Строка темы для исходящего сообщения электронной почты |
|
|
timezone
|
timezone | string |
TZ подписыватель должен быть допустимым в TZ в зависимости от часового пояса (см. раздел "Пользователь для сведений о часовом поясе"). Если пустое использует tz отправителя. |
|
|
Тип подписи
|
signature_type | integer |
Используйте 4, чтобы получить сертифицированный PDF-файл. Рекомендовано. По умолчанию используется хэш sha256 для целостности документов. |
|
|
Добавление PDF
|
append_pdf | boolean |
Добавьте сведения о проверке Legalesign в окончательный PDF-файл. |
|
|
auto_archive
|
auto_archive | boolean |
Отправьте в архив вскоре после подписания. Обеспечивает свободный доступ к веб-приложению |
|
|
Использование сообщений электронной почты Legalesign
|
do_email | boolean |
Используйте электронную почту Legalesign для отправки уведомлений. Если значение false подавляет все сообщения электронной почты. |
|
|
CC после завершения
|
cc_emails | string |
Строка с разделителями-запятыми адресов электронной почты, которые уведомляются о подписи или отклонении. |
|
|
Преобразование пустых полей отправителя в поля первого получателя
|
convert_sender_to_signer | boolean |
Если поля отправителя остаются пустыми, преобразуйте их в поля для первого получателя. |
|
|
Пароль PDF
|
pdf_password | string |
Укажите пароль. Необходимо иметь возможность кодирования ascii, необходимо также задать для signature_type значение 4 и выбрать pdf_password_type. |
|
|
Параметры пароля PDF
|
pdf_password_type | integer |
1, чтобы сохранить пароль, 2 для удаления из наших записей после окончательного подписания. |
|
|
pdftext
|
pdftext | object |
Назначьте значения полям отправителя PDF, используйте метку поля шаблона или его uuid в качестве ключей объектов. См. раздел templatepdf/:id/fields/ и фильтр для element_type="admin", чтобы получить соответствующие поля с меткой или uuid. См. также strict_fields. |
|
|
URL-адрес перенаправления
|
redirect | string |
URL-адрес для отправки подписывателя после входа (вместо страницы скачивания). URL-адрес будет включать параметры запроса с идентификатором и сведениями о состоянии следующим образом: YOUR-URL?signer=[signer_uid]&doc=[doc_id]&group=[group_id signer_state]&signer_state=[signer_status]&doc_state=[doc_status] |
|
|
Расписание напоминаний
|
reminders | string |
Поместите значение по умолчанию, если вы хотите использовать расписание напоминаний по умолчанию в группе (перейдите в веб-приложение, чтобы задать расписание по умолчанию) |
|
|
Возвращаемые ссылки подписи
|
return_signer_links | boolean |
Возвращать ссылки на документ для подписчиков в тексте ответа. |
|
|
Отправка последовательности
|
signers_in_order | boolean |
Уведомлять подписчиков в последовательности заказов. Если значение false все уведомляются имитацией. |
|
|
signertext
|
signertext | object |
Добавьте настраиваемые заполнители в поля подписывателя. Используйте метки полей или uuid в качестве ключей в объекте (как для pdftext). См. раздел templatepdf/:id/fields/ и фильтр для element_type = text, чтобы получить соответствующие поля с метками или uuid. |
|
|
Принудительное применение проверки поля
|
strict_fields | boolean |
Pdftext завершает проверку автоматически, задайте значение true для проверки. |
|
|
Ссылка
|
tag | string |
Тег |
|
|
Ссылка
|
tag1 | string |
Тег |
|
|
Ссылка
|
tag2 | string |
Тег |
|
|
Пользователь
|
user | string |
Назначьте документ другому пользователю в группе. |
Отправка сообщения электронной почты с напоминанием получателя
Отправьте получателю сообщение электронной почты с напоминанием.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор получателя
|
recipientId | True | uuid |
Идентификатор получателя |
|
текст
|
text | string |
Текст пользовательского сообщения |
Отправка шаблона PDF
Отправьте PDF-документ, который нужно отправить для подписи.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Архив при отправке
|
archive_upon_send | boolean |
Задайте значение true, если эта отправка будет использоваться только для одного использования. |
|
|
Группа
|
group | True | string |
Укажите группу, в которой будет использоваться эта функция. |
|
PDF-файл
|
pdf_file | True | byte |
Данные PDF-файла в кодировке Base64. |
|
Теги процесса
|
process_tags | boolean |
Если файл содержит текстовые теги, преобразуйте их в поля. |
|
|
Название
|
title | string |
Присвойт этому записи имя файла, если оно не используется. |
|
|
User
|
user | string |
Назначьте члену группы, если это не пользователь API. |
Получение вложений
Вывод списка вложений.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group | string |
Фильтрация по определенной группе. |
|
|
Ограничение запросов
|
limit | integer |
Используйте с смещением для итерации результатов. |
|
|
Смещение запросов
|
offset | integer |
Используйте с ограничением для итерации результатов. |
Возвращаемое значение
Перечисление вложений
Получение вложения
Получение вложения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachId | True | uuid |
Идентификатор вложения |
Возвращаемое значение
Присоединение элемента.
- Тело
- AttachmentResponse
Получение групп
Список групп, к которому принадлежит пользователь API.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Смещение запросов
|
offset | integer |
Смещение от начала набора данных. Используйте с запросом ограничения для итерации с помощью набора данных. |
|
|
Ограничение запросов
|
limit | integer |
Длина возвращаемого набора данных. Используйте запрос смещения для итерации результатов. |
Возвращаемое значение
Список групп
- Тело
- GroupListResponse
Получение документа
Возвращает определенный документ.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
Возвращаемое значение
Сведения о документе
Получение документов
Вывод списка неархивированных документов подписывания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group | True | string |
Фильтрация по определенной группе, обязательной. |
|
Включить архивные документы
|
archived | string |
Фильтрация по архивному состоянию, по умолчанию неархивирована, используйте все в этом параметре значение для запроса всех документов. |
|
|
Фильтрация по электронной почте получателя
|
string |
Фильтрация по электронной почте получателя. |
||
|
Ограничение запросов
|
limit | integer |
Длина возвращаемого набора данных. Используйте запрос смещения для итерации результатов. |
|
|
Смещение запросов
|
offset | integer |
Смещение от начала набора данных. Используйте с запросом ограничения для итерации с помощью набора данных. |
|
|
Фильтрация по состоянию документа
|
status | integer |
Фильтрация по состоянию документа. |
|
|
Удаление получателей из ответа
|
nosigners | string |
Добавьте значение 1, чтобы удалить сведения получателей для более быстрого запроса. |
|
|
Фильтр для создания после этой даты
|
created_gt | date-time |
Фильтрация для этих документов, созданных через определенное время. |
|
|
Фильтр для изменения после этой даты
|
modified_gt | date-time |
Фильтрация для этих документов, измененных через определенное время. |
Возвращаемое значение
Списки документов
- Тело
- DocumentListResponse
Получение полей документа
Поля из документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object |
Список полей документа |
|
|
element_type
|
element_type | string |
Тип элемента |
|
fieldorder
|
fieldorder | integer |
Порядок полей |
|
label
|
label | string |
Этикетка |
|
label_extra
|
label_extra | string |
Дополнительная метка |
|
Подписавшего
|
signer | integer |
Recipient |
|
государство
|
state | boolean | |
|
ратификация
|
validation | integer |
Идентификатор проверки |
|
value
|
value | string |
Ценность |
Получение полей формы получателя
Возвращает поля формы из определенного получателя.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор получателя
|
recipientId | True | uuid |
Идентификатор получателя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
|
array of object | ||
|
label
|
label | string |
Этикетка |
|
label_extra
|
label_extra | string |
Дополнительная метка |
|
государство
|
state | boolean |
Государство |
|
fieldorder
|
fieldorder | integer |
Порядок полей |
|
value
|
value | string |
Если поле является файлом для подписывания, это значение будет коротким url-адресом скачивания. |
Получение получателя
Получение состояния и сведений об отдельном получателе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор получателя
|
recipientId | True | uuid |
Идентификатор получателя |
Возвращаемое значение
Сведения о получателе
- Тело
- SignerResponse
Получение пользователя
Получение сведений о пользователе.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Код пользователя
|
userId | True | uuid |
Код пользователя |
Возвращаемое значение
Сведения о пользователе.
- Тело
- UserDetailResponse
Получение причины отклонения получателя
Возвращает причину, заданную для отклонения документа.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор получателя
|
recipientId | True | uuid |
Идентификатор получателя |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
статус
|
status | integer |
Статуи получателей. |
|
причина
|
reason | string |
Отклонить причину. |
Получение ссылки получателя
Ссылка с одним использованием для получателя для перехода на страницы подписывания.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор получателя
|
recipientId | True | uuid |
Идентификатор получателя |
Получение шаблона PDF
Сведения о конкретном шаблоне PDF
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Загруженный идентификатор PDF
|
pdfId | True | uuid |
Загруженный идентификатор PDF |
Возвращаемое значение
Сведения о шаблоне
- Тело
- TemplatePdfResponse
Получение шаблонов PDF
Вывод списка шаблонов PDF
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group | string |
Может быть полным resource_uri или только идентификатором. |
|
|
Ограничение запросов
|
limit | integer |
Длина возвращаемого набора данных. Используйте запрос смещения для итерации результатов. |
|
|
Смещение запросов
|
offset | integer |
Смещение от начала набора данных. Используйте с запросом ограничения для итерации с помощью набора данных. |
Возвращаемое значение
Списки шаблонов
Получить ссылку для внедрения PDF
Верните ссылку с одним использованием для внедрения редактора PDF.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор PDF
|
pdfId | True | string |
Задайте загруженный pdf-идентификатор. |
|
Скрытие списка полей на отрисованной странице
|
hide_sender_fields | boolean |
Скрытие списка полей на отрисованной странице. |
|
|
Шестнадцатеричный код, за исключением хэш-символа для цвета фона
|
css_body_backgroundcolor | string |
Используйте шестнадцатеричный код, за исключением хэш-символа, чтобы изменить цвет фона. |
Пустотный и архивный документ
Задает документ с состоянием 40 удален и архивирует его.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
|
Отправка уведомлений по электронной почте получателю
|
string |
Если задано значение true или 1 получатели уведомляются о том, что документ недействим. |
Скачать PDF
Получите черновик или окончательный PDF-файл для документа подписывания в зависимости от его состояния. Обратите внимание, что возможно ответ 200 или 302.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
Возвращаемое значение
- response
- file
Скачивание журнала аудита документов
PDF-файл только журнала аудита документов.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор документа
|
docId | True | uuid |
Идентификатор документа |
Возвращаемое значение
- response
- file
Удаление вложения
Удаление вложения.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор вложения
|
attachId | True | uuid |
Идентификатор подключения |
Член группы
Сведения о конкретном пользователе внутри группы.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор участника
|
memberId | True | uuid |
Идентификатор участника |
Возвращаемое значение
- Тело
- MemberResponse
Члены групп
Перечисления всех участников групп.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Идентификатор группы
|
group | string |
Фильтрация по определенной группе |
|
|
Ограничение запросов
|
limit | integer |
Используйте с смещением для итерации результатов. |
|
|
Смещение запросов
|
offset | integer |
Используйте с ограничением для итерации результатов. |
Возвращаемое значение
- Тело
- MemberListResponse
Триггеры
| Событие документа |
Триггер события документа возникает |
| Событие получателя |
Триггер при возникновении события получателя |
Событие документа
Триггер события документа возникает
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
Фильтр событий |
|
group
|
group | string |
Фильтр группы |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия |
|
объект
|
object | string |
Object |
|
tag1
|
data.tag1 | string |
Тег |
|
recipients
|
data.recipients | array of object |
Получатели |
|
UUID (Универсальный уникальный идентификатор)
|
data.recipients.uuid | string |
Идентификатор получателя |
|
электронная почта
|
data.recipients.email | string |
Электронная почта получателя |
|
заказ
|
data.recipients.order | integer |
Номер заказа получателя |
|
статус
|
data.recipients.status | integer |
Состояние получателя |
|
фамилия
|
data.recipients.lastname | string |
Фамилия получателя |
|
roleText
|
data.recipients.roleText | string |
Текст роли получателя |
|
первое имя
|
data.recipients.firstname | string |
Имя получателя |
|
statusText
|
data.recipients.statusText | string |
StatusText получателя |
|
resourceUri
|
data.recipients.resourceUri | string |
Универсальный код ресурса получателя |
|
rejectReason
|
data.recipients.rejectReason | string |
rejectReason |
|
groupResourceUri
|
data.groupResourceUri | string |
Универсальный код ресурса группы |
|
statusText
|
data.statusText | string |
Текст состояния документа |
|
имя
|
data.name | string |
Название документа |
|
tag
|
data.tag | string |
Тег |
|
resourceUri
|
data.resourceUri | string |
URI ресурса |
|
UUID (Универсальный уникальный идентификатор)
|
data.uuid | string |
Идентификатор документа |
|
tag2
|
data.tag2 | string |
Tag2 |
|
group
|
data.group | string |
Группа |
|
статус
|
data.status | integer |
Статус документа |
|
создано
|
created | integer |
Создано |
|
id
|
id | string |
Делать |
|
событие
|
event | string |
Event |
Событие получателя
Триггер при возникновении события получателя
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
eventFilter
|
eventFilter | True | string |
Фильтр событий |
|
group
|
group | string |
Фильтр группы |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
version
|
version | string |
Версия |
|
объект
|
object | string |
Object |
|
tag
|
data.tag | string |
Тег |
|
tag1
|
data.tag1 | string |
Tag1 |
|
tag2
|
data.tag2 | string |
Tag2 |
|
UUID (Универсальный уникальный идентификатор)
|
data.uuid | string |
Идентификатор получателя |
|
электронная почта
|
data.email | string |
Адрес электронной почты |
|
group
|
data.group | string |
Группа |
|
заказ
|
data.order | integer |
Заказ |
|
статус
|
data.status | integer |
Состояние |
|
документ
|
data.document | string |
Документ |
|
фамилия
|
data.lastname | string |
Фамилия |
|
roleText
|
data.roleText | string |
Текст роли |
|
первое имя
|
data.firstname | string |
Имя (первое имя) |
|
statusText
|
data.statusText | string |
Текст состояния |
|
emailBounce
|
data.emailBounce | integer |
Сообщение электронной почты отскочило |
|
resourceUri
|
data.resourceUri | string |
Универсальный код ресурса получателя |
|
documentName
|
data.documentName | string |
Название документа |
|
rejectReason
|
data.rejectReason | string |
Отклонение причины |
|
groupResourceUri
|
data.groupResourceUri | string |
Универсальный код ресурса группы |
|
emailBounceMessage
|
data.emailBounceMessage | string |
Сообщение об отказе по электронной почте |
|
documentResourceUri
|
data.documentResourceUri | string |
URI ресурса документа |
|
создано
|
created | integer |
Создано |
|
id
|
id | string |
Идентификатор |
|
событие
|
event | string |
Event |
Определения
PermissionsEnum
ListMeta
Метаданные о перечислении.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
limit
|
limit | integer |
Максимальное количество объектов. |
|
next
|
next | string |
URL-адрес для следующего набора объектов. |
|
offset
|
offset | integer |
Количество элементов из начала набора результатов. |
|
предыдущий
|
previous | string |
URL-адрес для предыдущего набора объектов. |
|
total_count
|
total_count | integer |
Общее количество объектов. |
GroupListResponse
Список групп
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мета
|
meta | ListMeta |
Метаданные о перечислении. |
|
объектов
|
objects | array of object | |
|
создано
|
objects.created | date-time |
Создано |
|
is_active
|
objects.is_active | boolean |
Active |
|
изменено
|
objects.modified | date-time |
Изменено |
|
имя
|
objects.name | string |
Имя |
|
public_name
|
objects.public_name | string |
Общедоступное имя |
|
resource_uri
|
objects.resource_uri | string |
URI ресурса |
|
слизняк
|
objects.slug | string |
Уникальное имя |
|
Пользователь
|
objects.user | string |
Универсальный код ресурса Creator |
|
xframe_allow
|
objects.xframe_allow | boolean |
Разрешить подписывание внедрения |
|
xframe_allow_pdf_edit
|
objects.xframe_allow_pdf_edit | boolean |
Разрешить редактирование внедрения |
TemplatePdfListResponse
Списки шаблонов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мета
|
meta | ListMeta |
Метаданные о перечислении. |
|
объектов
|
objects | array of TemplatePdfResponse |
TemplatePdfResponse
Сведения о шаблоне
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | date-time |
Создано |
|
group
|
group | string |
Универсальный код ресурса (URI) группы |
|
изменено
|
modified | date-time |
Изменено |
|
Сторон
|
parties | string |
Строковый массив json сторон документа. |
|
page_count
|
page_count | integer |
Количество страниц |
|
resource_uri
|
resource_uri | string |
URI ресурса |
|
signer_count
|
signer_count | integer |
Число подписывателя |
|
title
|
title | string |
Название |
|
Пользователь
|
user | string |
URI ресурса создателя |
|
UUID (Универсальный уникальный идентификатор)
|
uuid | uuid |
Идентификатор PDF |
|
действительный
|
valid | boolean |
Может отправляться (если поля не проверяются). |
DocumentListResponse
Списки документов
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мета
|
meta | ListMeta |
Метаданные о перечислении. |
|
объектов
|
objects | array of object |
Documents |
|
Архив
|
objects.archived | boolean |
Archived |
|
auto_archive
|
objects.auto_archive | boolean |
Архивируйте после отправки. |
|
cc_emails
|
objects.cc_emails | string |
Сообщения электронной почты с разделителями-запятыми, которые будут отображаться после завершения. |
|
создано
|
objects.created | date-time |
Создано |
|
do_email
|
objects.do_email | boolean |
Используйте сообщения электронной почты Legalesign. |
|
download_final
|
objects.download_final | boolean |
Готов скачать после завершения. |
|
group
|
objects.group | string |
Универсальный код ресурса группы. |
|
изменено
|
objects.modified | date-time |
Изменено |
|
имя
|
objects.name | string |
Название документа |
|
pdftext
|
objects.pdftext | string |
Значения полей отправителя |
|
перенаправить
|
objects.redirect | string |
URL-адрес перенаправления получателя после подписания |
|
resource_uri
|
objects.resource_uri | string |
URI ресурса |
|
return_signer_links
|
objects.return_signer_links | boolean |
Добавление ссылок получателя на ответ |
|
подписыватели
|
objects.signers | array of array |
Вложенные массивы с сведениями о подписывшем |
|
items
|
objects.signers | array of |
Всегда содержит [uri подписывающего пользователя, имя, фамилия, адрес электронной почты, номер sms, has_fields, состояние, порядок подписи (0-индексированные)] |
|
signers_in_order
|
objects.signers_in_order | integer |
Получатели электронной почты имитируются последовательно или последовательно |
|
статус
|
objects.status | DocumentStatusEnum |
Параметры состояния документа:
|
|
tag
|
objects.tag | string |
Документ тега |
|
tag1
|
objects.tag1 | string |
Документ тега |
|
tag2
|
objects.tag2 | string |
Документ тега |
|
шаблон
|
objects.template | string |
Универсальный код ресурса шаблона при использовании |
|
templatepdf
|
objects.templatepdf | string |
URI ресурса шаблона PDF |
|
текст
|
objects.text | string |
Текст для подписывания |
|
Пользователь
|
objects.user | string |
URI создателя |
|
UUID (Универсальный уникальный идентификатор)
|
objects.uuid | uuid |
Идентификатор документа |
DocumentStatusEnum
Параметры состояния документа:
- 10— начальное состояние, состояние подписывателя для отправки или отмены
- 20 . Поля завершены
- 30 — подписанный
- 40 — удалено (перед подписью)
- 50 - отклонено
Параметры состояния документа:
- 10— начальное состояние, состояние подписывателя для отправки или отмены
- 20 . Поля завершены
- 30 — подписанный
- 40 — удалено (перед подписью)
- 50 - отклонено
SignerResponse
Сведения о получателе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
документ
|
document | string |
Документ |
|
электронная почта
|
string |
Электронная почта получателя |
|
|
первое имя
|
first_name | string |
Имя получателя |
|
Фамилия
|
last_name | string |
Фамилия получателя |
|
has_fields
|
has_fields | boolean |
Получатель имеет поля |
|
заказ
|
order | integer |
Заказ получателя |
|
resource_uri
|
resource_uri | string |
Универсальный код ресурса получателя |
|
статус
|
status | SignerStatusEnum |
Параметры состояния подписывющего средства:
|
SignerStatusEnum
Параметры состояния подписывющего средства:
- 4 — отступ
- 5 — запланировано отправку
- 10 — отправлено
- 15 — открытое письмо
- 20 - посетил
- 30 — поля завершены
- 35. Поля завершены сигнатурой
- 39— ожидание завершения свидетеля
- 40 — подписанный
- 50 — скачанный
- 60 - отклонено
Параметры состояния подписывющего средства:
- 4 — отступ
- 5 — запланировано отправку
- 10 — отправлено
- 15 — открытое письмо
- 20 - посетил
- 30 — поля завершены
- 35. Поля завершены сигнатурой
- 39— ожидание завершения свидетеля
- 40 — подписанный
- 50 — скачанный
- 60 - отклонено
DocumentResponseDetail
Сведения о документе
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Архив
|
archived | boolean |
Архивирован |
|
auto_archive
|
auto_archive | boolean |
Отправьте архив документов после подписания. |
|
cc_emails
|
cc_emails | string |
Кто будет cc'd с отправителем в уведомлении по электронной почте при подписании |
|
создано
|
created | date-time |
Создано |
|
do_email
|
do_email | boolean |
Использование сообщений электронной почты Legalesign |
|
download_final
|
download_final | boolean |
Окончательный PDF-файл доступен для скачивания |
|
нижний колонтитул
|
footer | string |
Документы HTML — текст для нижнего колонтитула при использовании |
|
footer_height
|
footer_height | integer |
Документация по HTMl — высота px нижнего колонтитула при использовании |
|
group
|
group | string |
Универсальный код ресурса группы |
|
has_fields
|
has_fields | boolean |
Документ содержит поля |
|
hash_value
|
hash_value | string |
Контрольная сумма SHA256 для окончательной документации используйте ее для проверки окончательного скачивания PDF |
|
заголовок
|
header | string |
Документы HTML — текст заголовка при использовании |
|
header_height
|
header_height | integer |
Документация по HTMl — высота px заголовка при использовании |
|
изменено
|
modified | date-time |
Изменено |
|
имя
|
name | string |
Название документа |
|
pdf_password
|
pdf_password | string |
Пароль PDF |
|
pdf_password_type
|
pdf_password_type | string |
Если пароль pdf сохраняется |
|
pdftext
|
pdftext | string |
Игнорировать это |
|
перенаправить
|
redirect | string |
URL-адрес перенаправления получателя после подписания |
|
resource_uri
|
resource_uri | string |
URI ресурса |
|
return_signer_links
|
return_signer_links | boolean |
Игнорировать |
|
sign_mouse
|
sign_mouse | boolean |
игнорировать |
|
sign_time
|
sign_time | date-time |
Время подписи |
|
sign_type
|
sign_type | boolean |
устаревший |
|
sign_upload
|
sign_upload | boolean |
устаревший |
|
signature_placement
|
signature_placement | integer |
устаревший |
|
signature_type
|
signature_type | integer |
устаревшая версия — всегда 4 |
|
подписыватели
|
signers | array of array |
Вложенные массивы с сведениями о подписывшем |
|
items
|
signers | array of |
Всегда содержит [uri подписывающего пользователя, имя, фамилия, адрес электронной почты, номер sms, has_fields, состояние, порядок подписи (0-индексированные)] |
|
signer_objects
|
signer_objects | array of object |
Список получателей |
|
электронная почта
|
signer_objects.email | string |
Адрес электронной почты |
|
первое имя
|
signer_objects.firstname | string |
Имя (первое имя) |
|
фамилия
|
signer_objects.lastname | string |
Фамилия |
|
телефон
|
signer_objects.tel | string |
Номер телефона |
|
заказ
|
signer_objects.order | integer |
Порядок подписывания |
|
resource_uri
|
signer_objects.resource_uri | string |
URI ресурса |
|
роль
|
signer_objects.role | string |
Role |
|
статус
|
signer_objects.status | integer |
Код состояния получателя |
|
UUID (Универсальный уникальный идентификатор)
|
signer_objects.uuid | string |
Идентификатор получателя |
|
signers_in_order
|
signers_in_order | boolean |
Получатели электронной почты имитируются последовательно или последовательно |
|
статус
|
status | DocumentStatusEnum |
Параметры состояния документа:
|
|
tag
|
tag | string |
Ссылка |
|
tag1
|
tag1 | string |
Ссылка |
|
tag2
|
tag2 | string |
Ссылка |
|
шаблон
|
template | string |
URI ресурса для текстового шаблона при использовании |
|
templatepdf
|
templatepdf | string |
URI ресурса для шаблона PDF при использовании |
|
текст
|
text | string |
Текст документа при использовании |
|
Пользователь
|
user | string |
URI ресурса пользователя. |
|
UUID (Универсальный уникальный идентификатор)
|
uuid | uuid |
Идентификатор документа |
MemberListResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мета
|
meta | ListMeta |
Метаданные о перечислении. |
|
объектов
|
objects | array of MemberResponse |
MemberResponse
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | date-time |
Создано |
|
group
|
group | string |
Универсальный код ресурса группы |
|
изменено
|
modified | date-time |
Изменено |
|
разрешение
|
permission | PermissionsEnum |
Параметры разрешений |
|
resource_uri
|
resource_uri | string |
URI ресурса |
|
Пользователь
|
user | string |
URI ресурса пользователя. |
AttachmentResponse
Присоединение элемента.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
создано
|
created | date-time |
Создано |
|
описание
|
description | string |
Description |
|
filename
|
filename | string |
Имя файла |
|
group
|
group | string |
Группа |
|
resource_uri
|
resource_uri | string |
Присоединение ресурса URI |
|
Пользователь
|
user | string |
URI ресурса пользователя |
|
UUID (Универсальный уникальный идентификатор)
|
uuid | uuid |
Идентификатор подключения |
AttachmentListResponse
Перечисление вложений
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
мета
|
meta | ListMeta |
Метаданные о перечислении. |
|
объектов
|
objects | array of object |
Распечатка |
|
создано
|
objects.created | date-time |
Создано |
|
описание
|
objects.description | string |
Description |
|
filename
|
objects.filename | string |
Имя файла |
|
group
|
objects.group | string |
Группа |
|
resource_uri
|
objects.resource_uri | string |
URI ресурса |
|
Пользователь
|
objects.user | string |
URI ресурса пользователя |
|
UUID (Универсальный уникальный идентификатор)
|
objects.uuid | uuid |
Идентификатор подключения |
UserDetailResponse
Сведения о пользователе.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
date_joined
|
date_joined | date-time |
Дата присоединения |
|
электронная почта
|
Адрес электронной почты |
||
|
первое имя
|
first_name | string |
Имя (первое имя) |
|
groups
|
groups | array of string |
Список групп, присоединенных к этому пользователю. |
|
last_login
|
last_login | date-time |
Последнее имя входа |
|
Фамилия
|
last_name | string |
Фамилия |
|
resource_uri
|
resource_uri | string |
URI ресурса |
|
timezone
|
timezone | string |
Часовой пояс |
|
username
|
username | string |
Имя пользователя |
file
Это базовый тип данных file.