Знак Nitro (предварительная версия)

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

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

Service 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)
Контакт
Имя Поддержка nitro
URL https://www.gonitro.com/support
Сообщение электронной почты prosupport@sfdc.gonitro.com
Метаданные соединителя
Publisher Nitro PDF
Веб-сайт https://www.gonitro.com/
Политика конфиденциальности https://www.gonitro.com/legal/privacy-policy
Categories Производительность; ИТ-операции

Соединитель подписей Nitro

Overview

Соединитель Nitro Sign обеспечивает безопасные комплексные рабочие процессы eSignature непосредственно из Power Automate и Power Apps. Это позволяет приложениям создавать конверты подписывания, отправлять и изменять порядок документов, добавлять участников и определять порядок подписи, размещать поля подписи и данные, отправлять документы для подписи, отслеживать ход выполнения и скачивать исходные, запечатанные и запечатанные файлы аудита— все с помощью полностью автоматизированного, управляемого API. Потоки также можно запускать автоматически с помощью триггеров , которые запускают, когда что-то происходит в nitro Sign.

Publisher: Nitro Software

Необходимые условия

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

  • Учетная запись Nitro с включенным знаком Nitro
    https://developers.gonitro.com/
  • План Microsoft PowerApps или Power Automate с возможностями пользовательского соединителя.

Аутентификация

Знак Nitro использует OAuth 2.0 компьютера с предоставлением учетных данных клиента для создания маркеров доступа для запросов API.

Принцип работы

  • Вы создаете приложение API на портале самообслуживания Nitro и получаете связанный идентификатор клиента и секрет клиента.
  • Соединитель проходит проверку подлинности путем обмена этими учетными данными для маркера доступа носителя .
  • Затем маркер используется для авторизации последующих вызовов API подписи Nitro.

Создайте учетные данные и ознакомьтесь с подробным руководством.
https://developers.gonitro.com/docs/authentication/credentials

Создание подключения в Power Automate / Power Apps

При добавлении соединителя в поток или приложение:

  1. Нажмите кнопку "Добавить новое подключение".
  2. Введите идентификатор клиента и секрет клиента (выданный на портале разработчика Nitro).
  3. Выберите регион Nitro (Европа, США или APAC) — регион, связанный с вашей учетной записью Nitro.
  4. Сохраните подключение — при первом использовании соединитель обменивается идентификатором клиента и секретом клиента для кратковременного маркера доступа с помощью предоставления учетных данных клиента OAuth 2.0, кэширует его и обновляет его автоматически. Учетные данные используются только для получения маркера; последующие вызовы API проходят проверку подлинности с помощью маркера носителя от вашего имени.

Примечание. Не требуется интерактивный вход пользователя; этот поток предназначен для сценариев "сервер — сервер" или "приложение — приложение".

Поддерживаемые операции

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

1. Конверты

Конверт — это контейнер для документов, участников и полей в одном запросе подписи.

  • Вывод списка конвертов
    Возвращает все конверты, связанные с приложением в учетной записи. Результаты разбиены на страницы: ответ включает маркер курсора следующей страницы , который можно предоставить необязательному параметру Page After для получения следующей страницы (или страницы до обратной страницы). Оба параметра курсора находятся в разделе "Дополнительно" и необходимы только при переходе через большие результирующие наборы.

  • Создание конверта
    Создает новый конверт с именем, сообщением уведомления (тема и текст, с динамическими переменными, такими как $(sender_name_or_email) и $(envelope_name)), и режимом подписывания:

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

  • Получение конверта по идентификатору
    Извлекает сведения о конкретном конверте по идентификатору UUID.

  • Обновление конверта
    Обновляет имя конверта, параметры уведомлений и (или) режим подписи. Все поля являются необязательными.

  • Удаление конверта по идентификатору
    Окончательно удаляет конверт и все связанные документы, поля и участники. Это не может быть отменено.

  • Отправка конверта для подписывания
    Отправляет конверт участникам для сбора подписей. Перед отправкой конверт должен иметь свои документы, участники и поля подписывания (с помощью идентификатора конверта, создания участников по идентификатору конверта и создания полей по идентификатору документа). Перед отправкой конверта все документы в конверте должны иметь состояние отправки.

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

  • Отмена конверта по идентификатору
    Отменяет запрос подписи. Можно отменить только конверты, которые уже отправлены для подписания.

2. Документы

Документы — это файлы, присоединенные к конверту и подписанные участниками.

  • Вывод списка документов по идентификатору конверта
    Извлекает все документы, связанные с конвертом.

  • Создание документа по идентификатору конверта
    Отправляет документ в существующий конверт. Укажите файл плюс простые, типизированные поля — без рукописного написания JSON:

    • Файл документа — файл для отправки.
    • Имя документа — имя для хранения документа.
    • Тип контента(advanced, необязательный) — тип MIME файла; значение application/pdfпо умолчанию . Если опущено, принимаются только PDF-файлы.

  • Получение документа по идентификатору
    Извлекает сведения о конкретном документе в конверте.

  • Обновление документа по идентификатору
    Обновляет метаданные документа. В настоящее время можно изменить только имя документа.

  • Удаление документа по идентификатору
    Окончательно удаляет документ из конверта.

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

3. Поля

Поля — это интерактивные элементы (подпись, инициалы, дата и т. д.), помещенные в документ и назначенные участнику.

  • Вывод списка полей по идентификатору документа
    Извлекает все поля, связанные с определенным документом.

  • Создание полей по идентификатору документа
    Создает одно или несколько полей в документе и назначает их участникам. Укажите один элемент для одного поля или нескольких элементов для массового запроса. Каждое поле указывает:

    • participantID — участник, назначенный полю.
    • type— один из signature, initialsnamedatetitlecompany, , . checkboxcustom
    • page — номер страницы (индексирование на основе 1).
    • Положение X, позиция Y, ширина, высота — положение и размер поля, каждое введенное как отдельное число в точках (X/Y измеряется от левого или верхнего края страницы). Они заменяют предыдущий один boundingBox массив, поэтому каждое значение является типизированным полем в пользовательском интерфейсе, а не вручную созданным списком.
    • Необязательно: required (по умолчанию true) и в разделе "Дополнительно " format (например MM/DD/YYYY , для полей дат) и modifiable.

  • Обновление поля по идентификатору
    Обновляет свойства существующего поля. Поле type должно быть предоставлено и должно соответствовать существующему типу поля— оно используется для идентификации схемы поля и не изменяет тип поля.

  • Удаление поля по идентификатору
    Окончательно удаляет поле из документа.

4. Участники

Участники — это люди, получающие конверт , подписывать его или получать сведения.

  • Вывод списка участников по идентификатору конверта
    Извлекает всех участников, связанных с конвертом.

  • Создание участников по идентификатору конверта
    Добавляет одного или нескольких участников в конверт. Укажите один элемент для одного участника или нескольких элементов для массового запроса. Каждый участник указывает:

    • email — адрес электронной почты участника.
    • role — signer (может иметь поля, назначенные для подписывания) или cc (доступ только для чтения).
    • authentication (дополнительно, необязательно) — в настоящее время код доступа: статический код доступа, который участник должен предоставить перед подписью. Откройте этот раздел, только если участник должен пройти проверку подлинности перед подписью.

  • Обновление участника по идентификатору
    Обновляет параметры проверки подлинности участника. Невозможно изменить сообщение электронной почты участника.

  • Удаление участника по идентификатору
    Окончательно удаляет участника из конверта.

5. Скачивание

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

  • Скачать исходный конверт
    Загружает исходные неподписанные документы из конверта в zip-архив .

  • Скачать запечатанный конверт
    Загружает запечатанные подписанные документы вместе с следом аудита в виде ZIP-архива .

  • Скачивание запечатанных документов по идентификатору
    Загружает один запечатанный подписанный документ в виде PDF-файла .

  • Скачивание журнала аудита конверта
    Загружает полный журнал аудита для конверта в виде PDF-файла .

Действия загрузки предоставляют маркеры содержимого файла и имени файла на собственном языке (плюс тип содержимого файла). Перетащите содержимое файла прямо в входные данные файла нижнего шага ( например, OneDrive / SharePoint Создать файл и имя файла в входные данные имени файла. Выражение body('Action_Name') или имя файла вручную не требуется; соединитель упаковывает скачанный ZIP-файл или PDF-файл в конверт JSON, чтобы Power Automate поверхности этих файлов как обычные маркеры динамического содержимого.

6. Триггеры

Триггеры запускают поток автоматически, когда что-то происходит в nitro Sign, поэтому вам не нужно опрашивать изменения. Выберите триггер в качестве первого шага потока; Затем знак Nitro уведомляет Power Automate при возникновении этого события.

Нет ничего, чтобы настроить— имя события для ввода, url-адрес обратного вызова для вставки не требуется. Включение потока регистрации подписки с помощью знака Nitro для вас.

Триггеры жизненного цикла конверта

  • При создании конверта Возникает при создании нового конверта, например для регистрации каждого нового запроса подписи в список SharePoint или уведомления канала о том, что запрос был подготовлен.

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

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

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

  • При отмене конверта Возникает при отмене запроса подписи.

Триггеры участника

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

  • При отклонении запроса подписи Возникает, когда участник отказывается подписывать , обычно используется для оповещения отправителя или запуска процесса исключения.

Какой триггер дает вам

Каждый триггер выводит сведения о событии, а также конверт, к который он относится, как обычные маркеры динамического содержимого:

  • Тип события, идентификатор события, произошло в формате UTC — то, что произошло и когда. Идентификатор события является уникальным для каждого события и может использоваться для обнаружения повторяющихся данных.

  • Идентификатор учетной записи, идентификатор приложения, идентификаторконфигурации веб-перехватчика — учетная запись Nitro, приложение и подписка за уведомлением.

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

Пять триггеров рабочего процесса подписи, отправленные для подписи, подписи, отклонились и отменены, — дополнительные выходные данные:

  • Документы — документы в конверте (идентификатор документа, имя документа, страницы, размер файла, источник).

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

  • Участники совместной работы и пользовательское сообщение — записи участника совместной работы и сообщение, присоединенное к рабочему процессу подписывания.

Так как запросы подписи — это список, охватывающий каждого участника, используйте порядок подписи или состояние , чтобы выбрать участника, о котором вы заботитесь, а не предполагать первую запись. Знак Nitro не гарантирует порядок, в котором происходят события, поэтому обрабатывается в формате UTC в качестве центра по последовательности.

После создания конвертаподписывание завершается и запечатывается только идентификатор конверта и имя— эти события не несут сведения о документе или участнике. При необходимости используйте "Получить конверт по идентификатору " или "Список документов" по идентификатору конверта .

Важно: один активный триггер для каждого подключения

В настоящее время nitro Sign разрешает одну подписку на веб-перехватчик на идентификатор клиента. Так как каждый поток, использующий одни и те же общие папки подключения, что и идентификатор клиента, это имеет последствия для планирования:

Включение потока с триггером знака Nitro останавливает любой другой поток триггера nitro Sign, использующий то же подключение. Последний включенный поток — это тот, который получает события.

Затронутый поток остается включен в Power Automate и не показывает ошибки — он просто останавливается. Если требуется одновременное выполнение двух или нескольких потоков на основе триггеров, присвойте каждому отдельному подключению, созданному с другим идентификатором клиента Nitro. Потоки, использующие только действия (не триггеры), не затрагиваются и могут свободно предоставлять общий доступ к подключению.

Это временное ограничение платформы Nitro Sign. При отмене нескольких потоков триггеров можно будет предоставить общий доступ к одному подключению.

Отключение потока

При отключении потока его подписка может оставаться зарегистрированной на стороне знака Nitro. Он очищается автоматически при следующем включении потока триггера знака Nitro в этом соединении. В то же время знак Nitro может продолжать отправлять события для переключения потока; они удаляются, и поток не выполняется.

Если необходимо подтвердить текущее состояние, укажите конфигурации веб-перехватчика для приложения на портале разработчика Nitro.

Типичный рабочий процесс подписывания

Полный поток подписывания объединяет указанные выше действия по порядку. Общий поток Power Automate выглядит следующим образом:

  1. Создание конверта — задайте имя, тему или текст уведомления и режим подписывания (parallel или sequential). Сохраните возвращенный идентификатор конверта.
  2. Создание документа по идентификатору конверта — отправка одного или нескольких файлов в конверт (с помощью идентификатора конверта с шага 1). Сохраните каждый возвращенный идентификатор документа.
    (Необязательно)Переупорядочение документов по идентификатору конверта — задайте порядок документов.
  3. Создайте участники по идентификатору конверта — добавьте подписчиков и получателей CC с проверкой подлинности на основе кода доступа. Сохраните каждый возвращенный идентификатор участника.
  4. Создайте поля по идентификатору документа — поместите подпись/дату и т. д. поля в каждом документе и назначьте их участникам (используя идентификатор документа из шага 2 и идентификатор участника из шага 3).
  5. Отправка конверта для подписывания — отправка конверта. Сначала все документы должны находиться в состоянии отправки.
  6. (В ожидании)Отправить напоминания для участников конверта или отменить конверт по идентификатору , чтобы остановить запрос.
  7. (По завершении)Скачивание запечатанных конвертов / сзапечатанным документом по идентификатору / скачать журнал аудита конверта, чтобы получить готовые файлы.

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

Поток последующих действий на основе событий

Вместо ожидания внутри потока отправки можно реагировать на завершение в отдельном потоке:

  • При запечатанном конверте — триггер запускает поток и предоставляет идентификатор конверта.
  • Скачайте запечатанный конверт — передайтеидентификатор конверта триггера прямо в.
  • Создайте файл (OneDrive, SharePoint и т. д.) — удалите маркеры имени файла и содержимого файла в входные данные файла.

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

Ошибки и регулирование

API знака Nitro может возвращать следующие ошибки:

  • 400 — недопустимый запрос
  • 401 — несанкционированный
  • 404 — не найдено
  • 409 — конфликт (например, действие на конверте в состоянии, которое не разрешает операцию)
  • 413 — слишком большое содержимое
  • 415 — неподдерживаемый тип носителя
  • 422 — необработанные сущности
  • 500 — внутренняя ошибка сервера

Ограничение скорости

  • Вызовы API для каждого подключения: 100 в 60 секунд.

Ограничения платформы

Размер файла.

  • Максимальное: 25 МБ на запрос
    Применяется как к операциям с одним файлом, так и с несколькими файлами.

Число страниц

  • Максимум: 250 страниц на отдельный документ
    Всего объединенных страниц в нескольких документах может превышать 250.

Время хранения

  • Входные и выходные файлы удаляются примерно через 15 минут после завершения операции.

Подписки веб-перехватчика

  • Максимум: 1 активная подписка на идентификатор клиента. Используйте отдельное подключение, созданное с другим идентификатором клиента, для каждого потока на основе триггеров, который должен выполняться одновременно.

Примечания

  • Конверт, документ, поле и действия управления участниками возвращают JSON.
  • Действия загрузки возвращают файл (ZIP или PDF), упакованный в конверт JSON, предоставляющий имя файла, тип файла и содержимое файла в качестве маркеров выбора, поэтому результаты можно объединить в подчиненное действие файла без выражений.
  • Режим подписывания (parallel vs sequential) устанавливается при создании конверта и может быть изменен с помощью конверта обновления перед отправкой конверта.
  • Проверка подлинности участника в настоящее время поддерживает только код доступа .
  • Триггеры не требуют настройки. Включение потока регистрирует подписку nitro Sign автоматически. Одновременно может быть активен только один поток на основе триггеров для каждого подключения.

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательный
Идентификатор клиента Nitro securestring Идентификатор клиента приложения Nitro True
Секрет клиента Nitro securestring Секрет клиента приложения Nitro True
Регион Nitro string Выберите регион API Nitro для учетной записи. True

Действия

Вывод списка документов по идентификатору конверта

Извлекает все документы, связанные с определенным конвертом знака Nitro.
Вывод списка конвертов

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

Извлекает все поля, связанные с определенным документом в конверте знака Nitro.
Вывод списка участников по идентификатору конверта

Извлекает всех участников, связанных с определенным конвертом знака Nitro.
Изменение порядка документов по идентификатору конверта

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

Обновляет метаданные существующего документа в конверте знака Nitro. В настоящее время можно обновить только имя документа.
Обновление конверта

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

Обновляет свойства существующего поля в документе nitro Sign. Тип поля должен быть указан и должен соответствовать существующему типу поля; он используется API для идентификации схемы поля и не изменяет тип поля.
Обновление участника по идентификатору

Обновляет параметры проверки подлинности для участника в конверте знака Nitro. Невозможно обновить сообщение электронной почты участника.
Отмена конверта по идентификатору

Отменяет запрос подписи для конверта знака Nitro. Можно отменить только конверты, отправленные для подписания.
Отправка конверта для подписывания

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

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

Извлекает сведения о конкретном документе в конверте знака Nitro.
Получение конверта по идентификатору

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

Загружает запечатанные подписанные документы из конверта знака Nitro вместе с следом аудита в виде ZIP-архива.
Скачать исходный конверт

Загружает исходные неподписанные документы из конверта знака Nitro в виде ZIP-архива.
Скачивание журнала аудита конверта

Скачайте PDF-файл, содержащий полный след аудита для выбранного конверта знака Nitro.
Скачивание запечатанных документов по идентификатору

Загружает один запечатанный подписанный документ из конверта знака Nitro в виде PDF-файла.
Создание документа по идентификатору конверта

Отправляет документ в существующий конверт знака Nitro. Позже документ можно использовать в рабочем процессе подписывания.
Создание конверта

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

Создает одно или несколько полей в документе и назначает их участникам. Чтобы создать одно поле, укажите один элемент в массиве "Поля". Чтобы создать несколько полей, укажите несколько элементов.
Создание участников по идентификатору конверта

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

Окончательно удаляет документ из конверта знака Nitro.
Удаление конверта по идентификатору

Окончательно удаляет конверт знака Nitro. Эта операция не может быть отменена, а все связанные документы, поля и участники также удаляются.
Удаление поля по идентификатору

Окончательно удаляет поле из документа в конверте знака Nitro.
Удаление участника по идентификатору

Окончательно удаляет участника из конверта знака Nitro.

Вывод списка документов по идентификатору конверта

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

Извлекает все документы, связанные с определенным конвертом знака Nitro.

Параметры

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

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

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

Ответ возвращается при перечислении документов, связанных с конвертом знака Nitro.

Тело
ListDocumentsByEnvelopeIDResponse

Вывод списка конвертов

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

Конечная точка "Конверты списка" возвращает все конверты, связанные с приложением в учетной записи.

Параметры

Имя. Ключ Обязательно Тип Описание
Страница после
 pageAfter string

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

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

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

Имя. Путь Тип Описание
Конверты
 items array of EnvelopeSummaryResponse

Список конвертов.
Следующая страница
 nextPage string

Маркер курсора, который можно использовать как page After для получения следующей страницы конвертов.

Вывод списка полей по идентификатору документа

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

Извлекает все поля, связанные с определенным документом в конверте знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

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

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

Ответ возвращается после создания одного или нескольких полей.

Тело
FieldsResponse

Вывод списка участников по идентификатору конверта

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

Извлекает всех участников, связанных с определенным конвертом знака Nitro.

Параметры

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

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

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

Ответ возвращается при перечислении участников, связанных с конвертом знака Nitro.

Тело
ParticipantsListResponse

Изменение порядка документов по идентификатору конверта

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

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

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, документы которого должны быть переупорядочены.
Идентификаторы документов
 order True array of uuid

Массив идентификаторов документов, представляющих новый порядок документов в конверте.

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

Ответ возвращается при перечислении документов, связанных с конвертом знака Nitro.

Тело
ListDocumentsByEnvelopeIDResponse

Обновление документа по идентификатору

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

Обновляет метаданные существующего документа в конверте знака Nitro. В настоящее время можно обновить только имя документа.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий документ для обновления.
Имя документа
 name True string

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

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

Сведения о документе nitro Sign.

Тело
DocumentResponse

Обновление конверта

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

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

Параметры

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

Уникальный идентификатор UUID, определяющий конверт для обновления.
Имя конверта
 name string

Обновленное имя конверта. Это имя не обязательно должно быть уникальным.
Тема уведомлений
 subject string

Тема уведомления электронной почты, отправленная участникам подписи. Динамические переменные поддерживаются, например: $(sender_name_or_email) запрашивает подпись.
Текст уведомления
 body string

Текст электронной почты, отправленный участникам подписывания. Динамические переменные поддерживаются, например: Привет,\nподписать $(envelope_name)\nСпасибо,\n$(sender_name_or_email).
Режим подписывания
 mode string

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

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

Ответ возвращается после запроса или создания конверта знака Nitro.

Тело
EnvelopeResponse

Обновление поля по идентификатору

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

Обновляет свойства существующего поля в документе nitro Sign. Тип поля должен быть указан и должен соответствовать существующему типу поля; он используется API для идентификации схемы поля и не изменяет тип поля.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий документ, содержащий поле.
Идентификатор поля
 fieldID True uuid

Уникальный идентификатор UUID, определяющий поле для обновления.
Тип поля
 type True string

Текущий тип обновляемого поля. Это значение требуется API и должно соответствовать существующему типу поля; Он не изменяет тип поля.
Идентификатор участника
 participantID uuid

Уникальный идентификатор участника, назначенного полю.
Страница
 page integer

Номер страницы, в котором отображается поле. Страницы используют индексирование на основе 1.
Положение X
 x float

Optional. Горизонтальное положение поля, измеряемое с левого края страницы в точках.
Позиция Y
 y float

Optional. Вертикальное положение поля, измеряемое от верхнего края страницы в точках.
Ширина
 width float

Optional. Ширина поля в точках.
Высота
 height float

Optional. Высота поля в точках.
Обязательный
 required boolean

Указывает, должен ли участник завершить это поле.
Format
 format string

Формат поля, в котором применимо. Например, поля дат могут использовать такой формат, как MM/DD/ГГГГ.
Изменяемое
 modifiable boolean

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

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

Сведения о поле знака nitro.

Тело
FieldResponse

Обновление участника по идентификатору

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

Обновляет параметры проверки подлинности для участника в конверте знака Nitro. Невозможно обновить сообщение электронной почты участника.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий участника.
Идентификатор участника
 participantID True uuid

Уникальный идентификатор UUID, определяющий участника для обновления.
Тип проверки подлинности
 type string

Optional. Выберите метод проверки подлинности для участника. Если задано, необходимо также указать код доступа.
Код доступа
 accessCode string

Требуется только при указании типа проверки подлинности. Оставьте пустым, если проверка подлинности участника не требуется.

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

Сведения о участнике знака Nitro.

Тело
ParticipantResponse

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

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

Отменяет запрос подписи для конверта знака Nitro. Можно отменить только конверты, отправленные для подписания.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт для отмены.

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

Ответ возвращается после запроса или создания конверта знака Nitro.

Тело
EnvelopeResponse

Отправка конверта для подписывания

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

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

Параметры

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

Уникальный идентификатор UUID, определяющий конверт для отправки подписи.

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

Сводка сведений о конверте знака Nitro.

Тело
EnvelopeSummaryResponse

Отправка напоминаний для конверта

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

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

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, для которого должны отправляться уведомления о напоминаниях.
Тема уведомлений
 subject string

Тема уведомления электронной почты, отправленная участникам подписи. Динамические переменные поддерживаются, например: $(sender_name_or_email) запрашивает подпись.
Текст уведомления
 body string

Текст электронной почты, отправленный участникам подписывания. Динамические переменные поддерживаются, например: Привет,\nподписать $(envelope_name)\nСпасибо,\n$(sender_name_or_email).

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

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

Извлекает сведения о конкретном документе в конверте знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий полученный документ.

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

Сведения о документе nitro Sign.

Тело
DocumentResponse

Получение конверта по идентификатору

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

Извлекает сведения о конкретном конверте знака Nitro с помощью уникального идентификатора конверта.

Параметры

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

Уникальный идентификатор UUID, определяющий полученный конверт.

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

Ответ возвращается после запроса или создания конверта знака Nitro.

Тело
EnvelopeResponse

Скачать запечатанный конверт

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

Загружает запечатанные подписанные документы из конверта знака Nitro вместе с следом аудита в виде ZIP-архива.

Параметры

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

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

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

Скачанный файл, упакованный в виде конверта JSON.

Тело
FileDownloadResponse

Скачать исходный конверт

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

Загружает исходные неподписанные документы из конверта знака Nitro в виде ZIP-архива.

Параметры

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

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

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

Скачанный файл, упакованный в виде конверта JSON.

Тело
FileDownloadResponse

Скачивание журнала аудита конверта

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

Скачайте PDF-файл, содержащий полный след аудита для выбранного конверта знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, чей путь аудита должен быть скачан.

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

Скачанный файл, упакованный в виде конверта JSON.

Тело
FileDownloadResponse

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

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

Загружает один запечатанный подписанный документ из конверта знака Nitro в виде PDF-файла.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий запечатанный документ.
Код документа
 documentID True uuid

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

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

Скачанный файл, упакованный в виде конверта JSON.

Тело
FileDownloadResponse

Создание документа по идентификатору конверта

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

Отправляет документ в существующий конверт знака Nitro. Позже документ можно использовать в рабочем процессе подписывания.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, в котором будет отправлен документ.
Имя документа
 documentName True string

Имя документа для отправки. Это значение будет использоваться для создания метаданных документа, отправляемых в Nitro.
Тип контента
 contentType string

Тип контента отправленного документа. Для PDF-файлов используйте application/pdf. Если из метаданных опущено, принимаются только PDF-файлы.
Файл документа
 payload True file

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

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

Имя. Путь Тип Описание
Код документа
 ID uuid

Уникальный идентификатор UUID, определяющий отправленный документ.
Имя документа
 name string

Имя отправленного документа.
Создано в
 createdAt string

Метка времени, указывающая, когда был создан документ.
Состояние документа
 status string

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

Создание конверта

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

Создает новый конверт знака Nitro, который позже может быть заполнен документами, участниками, полями и отправлен для подписи.

Параметры

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

Имя конверта. Это имя не обязательно должно быть уникальным.
Режим подписывания
 mode True string

Определяет порядок подписывания. Используйте параллель, чтобы уведомлять всех участников одновременно или последовательно уведомлять участников по одному в том порядке, в который они были добавлены.
Тема уведомлений
 subject True string

Тема уведомления электронной почты, отправленная участникам подписи. Динамические переменные поддерживаются, например: $(sender_name_or_email) запрашивает подпись.
Текст уведомления
 body True string

Текст электронной почты, отправленный участникам подписывания. Динамические переменные поддерживаются, например: Привет,\nподписать $(envelope_name)\nСпасибо,\n$(sender_name_or_email).

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

Ответ возвращается после запроса или создания конверта знака Nitro.

Тело
EnvelopeResponse

Создание полей по идентификатору документа

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

Создает одно или несколько полей в документе и назначает их участникам. Чтобы создать одно поле, укажите один элемент в массиве "Поля". Чтобы создать несколько полей, укажите несколько элементов.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий документ, в котором должны быть созданы поля.
Идентификатор участника
 participantID True uuid

Уникальный идентификатор участника, назначенного полю.
Страница
 page True integer

Номер страницы, в котором должно быть помещено поле. Страницы используют индексирование на основе 1, поэтому первая страница — 1.
Тип поля
 type True string

Тип создаваемого поля.
Положение X
 x True float

Горизонтальное положение поля, измеряемое с левого края страницы в точках.
Позиция Y
 y True float

Вертикальное положение поля, измеряемое от верхнего края страницы в точках.
Ширина
 width True float

Ширина поля в точках.
Высота
 height True float

Высота поля в точках.
Обязательный
 required boolean

Указывает, должен ли участник завершить это поле.
Format
 format string

Необязательный формат для типов полей, поддерживающих форматирование, например поля дат. Пример: MM/DD/ГГГГ.
Изменяемое
 modifiable boolean

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

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

Ответ возвращается после создания одного или нескольких полей.

Тело
FieldsResponse

Создание участников по идентификатору конверта

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

Добавляет одного или нескольких участников в конверт знака Nitro. Чтобы добавить одного участника, укажите один элемент в массиве участников. Чтобы добавить нескольких участников, укажите несколько элементов.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, в котором должны быть добавлены участники.
Сообщение электронной почты
 email True email

Адрес электронной почты участника.
Role
 role True string

Роль участника. Подписыватель может иметь поля, назначенные для подписывания. Участник cc имеет доступ только для чтения.
Тип проверки подлинности
 type string

Optional. Выберите метод проверки подлинности для участника. Если задано, необходимо также указать код доступа.
Код доступа
 accessCode string

Требуется только при указании типа проверки подлинности. Оставьте пустым, если проверка подлинности участника не требуется.

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

Ответ возвращается после создания одного или нескольких участников.

Тело
ParticipantsResponse

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

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

Окончательно удаляет документ из конверта знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий документ для удаления.

Удаление конверта по идентификатору

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

Окончательно удаляет конверт знака Nitro. Эта операция не может быть отменена, а все связанные документы, поля и участники также удаляются.

Параметры

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

Уникальный идентификатор UUID, идентифицирующий конверт для удаления.

Удаление поля по идентификатору

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

Окончательно удаляет поле из документа в конверте знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий документ.
Код документа
 documentID True uuid

Уникальный идентификатор UUID, определяющий документ, содержащий поле.
Идентификатор поля
 fieldID True uuid

Уникальный идентификатор UUID, определяющий поле для удаления.

Удаление участника по идентификатору

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

Окончательно удаляет участника из конверта знака Nitro.

Параметры

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

Уникальный идентификатор UUID, определяющий конверт, содержащий участника.
Идентификатор участника
 participantID True uuid

Уникальный идентификатор UUID, определяющий участника для удаления.

Триггеры

Когда конверт запечатывается

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

Триггеры при начале подписывания и запечатывания всех участников.
При отклонении запроса подписи

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

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

Активирует при отправке конверта в рабочий процесс подписывания.
При подписании запроса подписи

Активирует, когда участник подписывает запрос подписи.
При создании конверта

Активирует при создании нового конверта знака Nitro (пакета).

Когда конверт запечатывается

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

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

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

События жизненного цикла (EnvelopeCreated, EnvelopeSigningCompleted, EnvelopeSealed). Полезные данные в реальном времени содержат только data.package с документами всегда пустыми.

Тело
NitroSignEnvelopeEvent

После завершения подписывания конверта

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

Триггеры при начале подписывания и запечатывания всех участников.

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

События жизненного цикла (EnvelopeCreated, EnvelopeSigningCompleted, EnvelopeSealed). Полезные данные в реальном времени содержат только data.package с документами всегда пустыми.

Тело
NitroSignEnvelopeEvent

При отклонении запроса подписи

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

Активирует, когда участник отклоняет запрос подписи.

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

События рабочего процесса (EnvelopeSentForSignature, SignatureRequestSigned, SignatureRequestDeclined, EnvelopeCancelled): data.package (full) + data.signatureWorkflow.

Тело
NitroSignEnvelopeWorkflowEvent

При отмене конверта

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

Активирует при отмене конверта.

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

События рабочего процесса (EnvelopeSentForSignature, SignatureRequestSigned, SignatureRequestDeclined, EnvelopeCancelled): data.package (full) + data.signatureWorkflow.

Тело
NitroSignEnvelopeWorkflowEvent

При отправке конверта для подписи

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

Активирует при отправке конверта в рабочий процесс подписывания.

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

События рабочего процесса (EnvelopeSentForSignature, SignatureRequestSigned, SignatureRequestDeclined, EnvelopeCancelled): data.package (full) + data.signatureWorkflow.

Тело
NitroSignEnvelopeWorkflowEvent

При подписании запроса подписи

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

Активирует, когда участник подписывает запрос подписи.

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

События рабочего процесса (EnvelopeSentForSignature, SignatureRequestSigned, SignatureRequestDeclined, EnvelopeCancelled): data.package (full) + data.signatureWorkflow.

Тело
NitroSignEnvelopeWorkflowEvent

При создании конверта

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

Активирует при создании нового конверта знака Nitro (пакета).

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

События жизненного цикла (EnvelopeCreated, EnvelopeSigningCompleted, EnvelopeSealed). Полезные данные в реальном времени содержат только data.package с документами всегда пустыми.

Тело
NitroSignEnvelopeEvent

Определения

NitroSignEnvelopeEvent

События жизненного цикла (EnvelopeCreated, EnvelopeSigningCompleted, EnvelopeSealed). Полезные данные в реальном времени содержат только data.package с документами всегда пустыми.

Имя. Путь Тип Описание
Тип события
 eventType string
Идентификатор события
 eventId string
Идентификатор учетной записи
 accountId string
Идентификатор приложения
 applicationId string
Идентификатор конфигурации веб-перехватчика
 webhookConfigId string
Произошло в формате UTC
 occurredAt string
пакет
 data.package NitroSignPackageSummary

Сводка конверта для событий, которые никогда не содержат документы.

NitroSignEnvelopeWorkflowEvent

События рабочего процесса (EnvelopeSentForSignature, SignatureRequestSigned, SignatureRequestDeclined, EnvelopeCancelled): data.package (full) + data.signatureWorkflow.

Имя. Путь Тип Описание
Тип события
 eventType string
Идентификатор события
 eventId string
Идентификатор учетной записи
 accountId string
Идентификатор приложения
 applicationId string
Идентификатор конфигурации веб-перехватчика
 webhookConfigId string
Произошло в формате UTC
 occurredAt string
пакет
 data.package NitroSignPackage
подписываниеWorkflow
 data.signingWorkflow NitroSignSigningWorkflow

NitroSignPackageSummary

Сводка конверта для событий, которые никогда не содержат документы.

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

NitroSignPackage

Имя. Путь Тип Описание
Идентификатор конверта
 id string
Имя конверта
 name string
Documents
 documents array of NitroSignPackageDocument

NitroSignPackageDocument

Имя. Путь Тип Описание
Код документа
 id string
Имя документа
 name string
Страницы
 pages integer
Размер файла (байты)
 fileSizeBytes integer
Происхождение
 origin string

NitroSigner

Также используется для объекта "user" участника совместной работы (та же фигура).

Имя. Путь Тип Описание
Электронная почта подписывющего средства
 email string
Имя подписывающего пользователя
 firstName string
Фамилия подписывющего пользователя
 lastName string

NitroSignatureRequest

Имя. Путь Тип Описание
Идентификатор участника
 participantId string
автор подписи
 signer NitroSignSigner

Также используется для объекта "user" участника совместной работы (та же фигура).
Status
 status string
Порядок подписывания
 order integer

NitroSignCollaborator

Наблюдаемые пустые в подписанных или отклоненных; Отменено отображение записи с пустыми идентификаторами участников и COLLABORATION_TYPE_UNKNOWN для совместной работы.

Имя. Путь Тип Описание
Идентификатор участника
 participantId string
user
 user NitroSignSigner

Также используется для объекта "user" участника совместной работы (та же фигура).
Тип совместной работы
 collaborationType string

NitroSigningWorkflow

Имя. Путь Тип Описание
Запросы подписи
 signatureRequests array of NitroSignSignatureRequest
Сотрудники
 collaborators array of NitroSignCollaborator
Пользовательское сообщение
 customMessage string

КонвертНотизация

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

Имя. Путь Тип Описание
Тема уведомлений
 subject string

Тема уведомления электронной почты, отправленная участникам подписи. Динамические переменные поддерживаются, например: $(sender_name_or_email) запрашивает подпись.
Текст уведомления
 body string

Текст электронной почты, отправленный участникам подписывания. Динамические переменные поддерживаются, например: Привет,\nподписать $(envelope_name)\nСпасибо,\n$(sender_name_or_email).

КонвертSummaryResponse

Сводка сведений о конверте знака Nitro.

Имя. Путь Тип Описание
Идентификатор конверта
 ID uuid

Уникальный идентификатор UUID, определяющий конверт.
Создано в
 createdAt date-time

Метка времени в формате UTC, указывающая, когда был создан конверт.
Последнее изменение в
 lastModifiedAt date-time

Метка времени UTC, указывающая время последнего изменения конверта.
Имя конверта
 name string

Имя конверта.
Состояние конверта
 status string

Внутреннее состояние конверта.

КонвертResponse

Ответ возвращается после запроса или создания конверта знака Nitro.

Имя. Путь Тип Описание
Идентификатор конверта
 ID uuid

Уникальный идентификатор UUID, определяющий конверт.
Создано в
 createdAt date-time

Метка времени в формате UTC, указывающая, когда был создан конверт.
Последнее изменение в
 lastModifiedAt date-time

Метка времени UTC, указывающая время последнего изменения конверта.
Имя конверта
 name string

Имя конверта.
Состояние конверта
 status string

Внутреннее состояние конверта.
Режим подписывания
 mode string

Режим подписывания, настроенный для конверта.
уведомление
 notification EnvelopeNotification

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

ListDocumentsByEnvelopeIDResponse

Ответ возвращается при перечислении документов, связанных с конвертом знака Nitro.

Имя. Путь Тип Описание
Documents
 items array of DocumentResponse

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

DocumentResponse

Сведения о документе nitro Sign.

Имя. Путь Тип Описание
Код документа
 ID uuid

Уникальный идентификатор UUID, определяющий документ.
Имя документа
 name string

Имя документа.
Создано в
 createdAt date-time

Метка времени UTC, указывающая, когда был создан документ.
Размер в байтах
 sizeBytes integer

Размер документа в байтах.
Количество страниц
 numPages integer

Количество страниц в документе.
Состояние документа
 status string

Текущее состояние документа.

FieldsResponse

Ответ возвращается после создания одного или нескольких полей.

Имя. Путь Тип Описание
Поля
 items array of FieldResponse

Поля, созданные в этом запросе.

FieldResponse

Сведения о поле знака nitro.

Имя. Путь Тип Описание
Идентификатор поля
 ID uuid

Уникальный идентификатор UUID, определяющий поле.
Идентификатор участника
 participantID uuid

Уникальный идентификатор участника, назначенного полю.
Код документа
 documentID uuid

Уникальный идентификатор документа, к которому принадлежит поле.
Страница
 page integer

Номер страницы, в котором отображается поле.
Ограничивающий прямоугольник
 boundingBox array of float

Массив из четырех чисел в формате [x, y, ширина, высота], измеряемый в точках.
Обязательный
 required boolean

Указывает, должен ли участник завершить это поле.
Тип поля
 type string

Тип поля.
Format
 format string

Формат поля, в котором применимо.
Изменяемое
 modifiable boolean

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

УчастникиResponse

Ответ возвращается после создания одного или нескольких участников.

Имя. Путь Тип Описание
Participants
 items array of ParticipantResponse

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

УчастникиListResponse

Ответ возвращается при перечислении участников, связанных с конвертом знака Nitro.

Имя. Путь Тип Описание
Participants
 items array of ParticipantResponse

Участники, связанные с конвертом.
Всего участников
 total integer

Общее количество участников, доступных в коллекции.

УчастникResponse

Сведения о участнике знака Nitro.

Имя. Путь Тип Описание
Идентификатор участника
 ID uuid

Уникальный идентификатор UUID, определяющий участника.
Сообщение электронной почты
 email email

Адрес электронной почты участника.
Role
 role string

Роль участника.
authentication
 authentication ParticipantAuthenticationResponse

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

УчастникAuthenticationResponse

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

Имя. Путь Тип Описание
Тип проверки подлинности
 type string

Тип проверки подлинности участника.
Код доступа
 accessCode string

Код доступа, настроенный для участника.

FileDownloadResponse

Скачанный файл, упакованный в виде конверта JSON.

Имя. Путь Тип Описание
Имя файла
 fileName string

Имя скачаированного файла, полученное из заголовка Content-Disposition ответа (например, result.zip или result.pdf). Удалите этот маркер непосредственно в входные данные имени файла нижестоящего действия, например OneDrive или SharePoint создать файл.
Тип контента файла
 fileContentType string

Тип MIME скачаемого файла, например application/zip или application/pdf.
Содержимое файла
 fileContent byte

Содержимое файла в кодировке Base64. Удалите этот маркер непосредственно в входные данные содержимого файла нижнего действия (например, OneDrive или SharePoint создать файл или другое действие Nitro) — выражение не требуется.