Поделиться через

BlueInk

Соединитель Blueink позволяет добавлять платформу eSignature Blueink в автоматизированные рабочие процессы. Соединитель позволяет проверить состояние пакета, создать новые пакеты, сведения о подписывшем доступе и многое другое.

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

Услуга 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)
Контакт
Имя Поддержка Blueink
URL https://help.blueink.com/en/
Адрес электронной почты support@blueink.com
Метаданные соединителя
Publisher Blueink
Веб-сайт https://blueink.com
Политика конфиденциальности https://blueink.com/privacy-policy/
Категории Управление бизнесом; Продуктивность

Благодаря этому универсальному соединителю пользователи могут легко интегрировать мощное решение eSignature Blueink в рабочий процесс, используя возможности различных соединителей Power Automate. Эта интеграция позволяет пользователям автоматизировать создание и распространение пакетов документов без усилий. Управляя гармоничным взаимодействием этого соединителя с другими соединителями, вы можете оптимизировать процессы управления документами, повысить эффективность и обеспечить простой и эффективный интерфейс подписывания документов для клиентов и заинтересованных лиц. Независимо от того, выполняется ли автоматизация утверждений контракта, обработка юридических документов или управление документами в любом другом контексте, этот соединитель предоставляет мощный инструмент для оптимизации рабочего процесса и повышения производительности.

Предпосылки

Чтобы использовать этот соединитель, вам потребуется учетная запись с поддержкой API из blueink.com.

Получение учетных данных

После создания учетной записи нажмите кнопку API в левой части страницы. В разделе "Закрытые ключи API" нажмите кнопку "Добавить ключ API ". Присвойте ключу API метку и нажмите клавишу SUBMIT. Скопируйте ключ API и сохраните его где-то, так как оно не будет отображаться снова.

Начало работы с соединителем

При первом создании подключения Blueink вам будет предложено ввести ключ API. Ключ API всегда должен начинаться с маркера , за которым следует пробел, а затем созданный ключ API. Ввод ключа API должен выглядеть так, как это ключ< API маркера>.

Популярное действие заключается в создании пакета. Для создания пакета требуется сложный набор входных данных. Ознакомьтесь с документацией https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle по API по тому, как может выглядеть переменная тела. Рисунок ниже в качестве примера текста создания пакета.

Создание пакета

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

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

Список пакетов

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

Текст JSON требуется для конечной точки создания пакета

Распространенные ошибки и средства устранения неполадок

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

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

Часто задаваемые вопросы

1. Что такое Blueink?

  • Blueink — это расширенное решение eSignature, упрощающее процесс подписывания документов, что упрощает отправку, подписывание и безопасное управление электронными документами.

2. Что такое Соединитель Майкрософт для Blueink?

  • Соединитель Microsoft для Blueink — это средство, которое позволяет пользователям легко интегрировать решение eSignature Blueink с Microsoft Power Automate, что обеспечивает автоматизацию и расширенное управление документами.

3. Как работает Соединитель Майкрософт для Blueink?

  • Соединитель позволяет создавать автоматизированные рабочие процессы, сочетая Blueink с другими соединителями Power Automate. Вы можете автоматизировать создание и распространение пакетов документов, повышая процессы управления документами.

4. Каковы некоторые варианты использования соединителя Microsoft для Blueink?

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

5. Можно ли использовать соединитель Майкрософт для Blueink с другими продуктами Майкрософт?

  • Да, соединитель предназначен для эффективной работы с различными продуктами и службами Майкрософт, что позволяет интегрировать Blueink eSignatures в рабочие процессы, ориентированные на Майкрософт.

6. Легко ли настроить и использовать Соединитель Майкрософт для Blueink?

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

7. Есть ли какие-либо затраты, связанные с использованием Microsoft Connector для Blueink?

  • Цены могут отличаться в зависимости от ваших соглашений об использовании и лицензировании. Лучше всего ознакомиться с Blueink или Корпорацией Майкрософт для конкретных сведений о ценах.

8. Можно ли получить поддержку для любых технических проблем с Microsoft Connector для Blueink?

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

9. Совместим ли соединитель Майкрософт для Blueink как со службами Windows, так и с облачными службами Майкрософт?

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

10. Где можно найти дополнительные сведения о Соединителе Майкрософт для Blueink?

  • Дополнительные сведения, включая руководства по настройке и документацию, можно посетить веб-сайт Blueink или ознакомиться с документацией По Microsoft Power Automate, связанной с этим соединителем.

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

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

По умолчанию

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

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

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

Имя Тип Description Обязательно
Ключ API Blueink securestring Ключ API Blueink. Это можно создать в Blueink на вкладке API. Правильный формат : Token XXXXXX, где XXXXXX — это ключ API. True

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

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

Действия

List WebhookExtraHeaders

Вывод списка всех веб-перехватчиковExtraHeaders в учетной записи BlueInk
Вывод списка веб-перехватчиков

Вывод списка всех веб-перехватчиков в учетной записи BlueInk
Добавление тегов в пакет

Добавьте дополнительные теги в пакет. Существующие теги в пакете не удаляются. Результатом этого вызова является объединение набора предыдущих тегов с набором новых тегов. Повторяющиеся теги игнорируются.
Обновление webhookExtraHeader

Обновление WebhookExtraHeader новыми данными
Обновление веб-перехватчика

Обновите веб-перехватчик новыми данными. Обратите внимание, что все подписки, которые опущены из этого запроса, будут УДАЛЕНЫ. Если вы не хотите заменить все данные в веб-перехватчике, скорее всего, вы хотите использовать PATCH.
Обновление пакета

Обновление пакета (подписывающего средства) с помощью нового адреса электронной почты, номера телефона, имени или проверки подлинности

Обновленный пакет по-прежнему должен быть доставлен. Например, если указать deliver_via значение "phone", но в исходном ПакетеRequest не было номера телефона, то этот запрос должен содержать также phone или будет возвращена ошибка.

Вы можете изменить пакет, который изначально настроен для внедренной подписи (то есть deliver_via был "внедрением" для доставки по электронной почте или SMS. Однако уведомления о подписи и напоминания не будут отправляться автоматически. Для отправки уведомления о подписи (или SMS) необходимо вызвать /packageId/{packetId}/напоминание/.

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

Обновите пользователя новыми данными. Обратите внимание, что все каналы контактов, которые опущены из этого запроса, будут УДАЛЕНЫ. Если вы не хотите заменить все данные на person, скорее всего, вы хотите использовать PATCH.
Отмена пакета

Отмена пакета, указанного в пакете Slug
Отправка напоминания

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

Вывод списка всех событий веб-перехватчика в учетной записи BlueInk
Перечисление веб-перехватчиков

Перечисление всех веб-перехватчиков в учетной записи BlueInk
Перечисление событий пакета

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

Повторное создание общего секрета веб-перехватчика
Получение веб-перехватчика

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

Получение сведений о веб-перехватчикеExtraHeader
Получение данных пакета

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

Получение общего секрета веб-перехватчика
Получение пакета

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

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

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

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

Получение шаблона документа
Создание URL-адреса внедренной подписи

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

Создание нового веб-перехватчика
Создание веб-перехватчикаExtraHeader

Создание нового заголовка веб-перехватчика
Создание пакета

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

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

Возвращает список пакетов с разбивкой на страницы в учетной записи, упорядоченный по дате создания (от последней до последней до последней). Управление разбивкой на страницы можно с помощью парамататоров разбиения на страницы (см. обзор-разбиение> на страницы). Параматизаторы фильтров запроса могут объединяться, например /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. При объединении фильтров возвращаются только пакеты, соответствующие всем фильтрам.
Список персон

Получите список лиц в вашей учетной записи. При необходимости можно отфильтровать список, предоставив поисковый запрос. Например, для поиска всех лиц с именем "Джон", вы будете использовать запрос search=John.
Список шаблонов документов

Вывод списка всех шаблонов документов
Удаление webhookExtraHeader

Удаление webhookExtraHeader
Удаление веб-перехватчика

Удаление веб-перехватчика по идентификатору
Удаление пользователя

Удаление человека. Это также приведет к удалению любого связанного пользователя BlueInk.
Удаление тегов из пакета

Удаление тегов из пакета. Если тег в запросе не существует в пакете, он игнорируется.
Частично обновите пользователя

Частично обновите пользователя новыми данными.

Чтобы добавить новый адрес электронной почты или телефон в Person, включите ContactChannel в массив "каналы" без идентификатора.

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

Если ContactChannel не содержит идентификатор, но электронная почта (или телефон) соответствует существующему ContactChannel, то этот contactChannel не будет изменен.
Частичное обновление webhookExtraHeader

Частично обновите WebhookExtraHeader новыми данными.
Частичное обновление веб-перехватчика

Частично обновите веб-перехватчик новыми данными.

List WebhookExtraHeaders

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

Вывод списка всех веб-перехватчиковExtraHeaders в учетной записи BlueInk

Параметры

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

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

Например. /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Тип события
 event_type string

Будут возвращены только webhookExtraHeaders с веб-перехватчиками, соответствующими выбранному event_type или event_types.

Например, /webhooks/headers/?event_type=bundle_sent например, /webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

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

Имя Путь Тип Описание
array of object
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

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

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

Вывод списка всех веб-перехватчиков в учетной записи BlueInk

Параметры

Имя Ключ Обязательно Тип Описание
Включен
 enabled boolean

Будут возвращены только веб-перехватчики, соответствующие выбранному состоянию "включено".

Например. /webhooks/?enabled=true
Тип события
 event_type string

Будут возвращены только веб-перехватчики, соответствующие выбранному event_type или event_types.

Например, /webhooks/?event_type=bundle_sent например, /webhooks/?event_type__in=bundle_error,bundle_cancelled

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

Имя Путь Тип Описание
array of object
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
имя
 extra_headers.name string

должен соответствовать RFC 7230
заказ
 extra_headers.order integer
value
 extra_headers.value string

должен соответствовать RFC 7230
веб-перехватчик
 extra_headers.webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

Добавление тегов в пакет

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

Добавьте дополнительные теги в пакет. Существующие теги в пакете не удаляются. Результатом этого вызова является объединение набора предыдущих тегов с набором новых тегов. Повторяющиеся теги игнорируются.

Параметры

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

Слизь, который однозначно идентифицирует пакет
tags
 tags array of string

Массив тегов

Обновление webhookExtraHeader

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

Обновление WebhookExtraHeader новыми данными

Параметры

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

Идентификатор, который однозначно идентифицирует WebhookExtraHeader
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

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

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

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

Обновление веб-перехватчика

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

Обновите веб-перехватчик новыми данными. Обратите внимание, что все подписки, которые опущены из этого запроса, будут УДАЛЕНЫ. Если вы не хотите заменить все данные в веб-перехватчике, скорее всего, вы хотите использовать PATCH.

Параметры

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

Идентификатор, который однозначно идентифицирует веб-перехватчик
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

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

Имя Путь Тип Описание
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
имя
 extra_headers.name string

должен соответствовать RFC 7230
заказ
 extra_headers.order integer
value
 extra_headers.value string

должен соответствовать RFC 7230
веб-перехватчик
 extra_headers.webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

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

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

Обновление пакета (подписывающего средства) с помощью нового адреса электронной почты, номера телефона, имени или проверки подлинности

Обновленный пакет по-прежнему должен быть доставлен. Например, если указать deliver_via значение "phone", но в исходном ПакетеRequest не было номера телефона, то этот запрос должен содержать также phone или будет возвращена ошибка.

Вы можете изменить пакет, который изначально настроен для внедренной подписи (то есть deliver_via был "внедрением" для доставки по электронной почте или SMS. Однако уведомления о подписи и напоминания не будут отправляться автоматически. Для отправки уведомления о подписи (или SMS) необходимо вызвать /packageId/{packetId}/напоминание/.

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

Параметры

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

Слизь, который однозначно идентифицирует пакет
body
 body

Обновление пользователя

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

Обновите пользователя новыми данными. Обратите внимание, что все каналы контактов, которые опущены из этого запроса, будут УДАЛЕНЫ. Если вы не хотите заменить все данные на person, скорее всего, вы хотите использовать PATCH.

Параметры

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

Идентификатор, который однозначно идентифицирует пользователя
электронная почта
 email email
id
 id uuid
добрый
 kind string

em для электронной почты. mp для телефона.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

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

Имя Путь Тип Описание
channels
 channels array of object
электронная почта
 channels.email email
id
 channels.id uuid
добрый
 channels.kind string

em для электронной почты. mp для телефона.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

Отмена пакета

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

Отмена пакета, указанного в пакете Slug

Параметры

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

Слизь, который однозначно идентифицирует пакет

Отправка напоминания

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

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

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

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

Вывод списка всех событий веб-перехватчика в учетной записи BlueInk

Параметры

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

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

Например. /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Тип события
 event_type string

Будут возвращены только веб-перехватчики с веб-перехватчиками, соответствующими выбранному event_type или event_types.

Например, /webhooks/events/?event_type=bundle_sent например, /webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Состояние
 status integer

Возвращаются только веб-перехватчики, соответствующие выбранному состоянию.

Например, /webhooks/events/?status=1 например, /webhooks/events/?status__in=0,1,2
Результат успешного выполнения
 success boolean

Возвращается только webhookEvents, соответствующий выбранному состоянию успешности.

Например. /webhooks/events/?success=true
Диапазон дат
 date date-time

Возвращается только веб-перехватчикEvents между диапазоном дат. Примечание. Даты выражаются как формат YYY-MM-DD.

Например. /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

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

Имя Путь Тип Описание
array of object
создано
 created date-time
Поставки
 deliveries array of object
сообщение
 deliveries.message string

сообщение, описывающее любые проблемы
pk
 deliveries.pk uuid
статус
 deliveries.status integer

сообщение о состоянии ответа или 0, если состояние отсутствует
отметка времени
 deliveries.timestamp date-time

когда произошла попытка доставки (начало попытки, а не при сбое, например время ожидания)
event_type
 event_type string
payload
 payload string

полезные данные для отправки по доставке; json
pk
 pk uuid
статус
 status integer

Код состояния последнего ответа из конечной точки веб-перехватчика. 0 указывает, что ответ не получен
success
 success boolean
веб-перехватчик
 webhook uuid

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

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

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

Перечисление всех веб-перехватчиков в учетной записи BlueInk

Параметры

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

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

Например. /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Идентификатор события веб-перехватчика
 webhook_event uuid

Возвращается только webhookDeliveries, соответствующий выбранному идентификатору webhook_event.

Например. /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Тип события
 event_type string

Будут возвращены только webhookDeliveries с веб-перехватчиками, соответствующими выбранному event_type или event_types.

Например, /webhooks/deliveries/?event_type=bundle_sent например, /webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Состояние
 status integer

Возвращается только webhookDeliveries, соответствующий выбранному состоянию.

Например, /webhooks/deliveries/?status=1 например, /webhooks/deliveries/?status__in=0,1,2
Диапазон дат
 date date-time

Возвращается только webhookDeliveries между диапазоном дат. Примечание. Даты выражаются как формат YYY-MM-DD.

Например. /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

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

Имя Путь Тип Описание
array of object
создано
 created date-time
Поставки
 deliveries array of object
сообщение
 deliveries.message string

сообщение, описывающее любые проблемы
pk
 deliveries.pk uuid
статус
 deliveries.status integer

сообщение о состоянии ответа или 0, если состояние отсутствует
отметка времени
 deliveries.timestamp date-time

когда произошла попытка доставки (начало попытки, а не при сбое, например время ожидания)
event_type
 event_type string
payload
 payload string

полезные данные для отправки по доставке; json
pk
 pk uuid
статус
 status integer

Код состояния последнего ответа из конечной точки веб-перехватчика. 0 указывает, что ответ не получен
success
 success boolean
веб-перехватчик
 webhook uuid

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

Перечисление событий пакета

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

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

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

Имя Путь Тип Описание
array of object
описание
 description string

Краткое описание события
добрый
 kind string

Тип события в виде 2 символьного кода
packet_id
 packet_id uuid

Идентификатор UUID пакета. Присутствует только в том случае, если событие связано с определенным пакетом.
отметка времени
 timestamp date-time

Время, в течение которого произошло событие

Повторное создание общего секрета webhook

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

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

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

Имя Путь Тип Описание
create_date
 create_date date-time
secret
 secret b58

Получение веб-перехватчика

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

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

Параметры

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

Идентификатор, который однозначно идентифицирует веб-перехватчик

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

Имя Путь Тип Описание
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
имя
 extra_headers.name string

должен соответствовать RFC 7230
заказ
 extra_headers.order integer
value
 extra_headers.value string

должен соответствовать RFC 7230
веб-перехватчик
 extra_headers.webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

Получение веб-перехватчикаExtraHeader

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

Получение сведений о веб-перехватчикеExtraHeader

Параметры

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

Идентификатор, который однозначно идентифицирует WebhookExtraHeader

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

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

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

Получение данных пакета

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

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

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

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

Массив вложений файлов для поля вложения или null
ext
 attachments.ext string

Расширение файла
is_image
 attachments.is_image boolean

Значение true, если этот файл вложения является изображением
имя
 attachments.name string

Имя файла вложения
число
 attachments.num integer

Порядок добавления файла при наличии нескольких отправлений для одного поля вложения (например, фотография для каждой страницы документа, взятого с веб-камерой)
size
 attachments.size integer

Размер файла в байтах
URL-адрес
 attachments.url url

URL-адрес, который можно использовать временно для скачивания файла вложения
doc_key
 doc_key string

Ключ уникально идентифицирует этот документ в пакете (из исходного пакетаRequest)
field_key
 field_key string

Ключ уникально идентифицирует поле в документе (как указано в исходном DocumentRequestField в DocumentRequest в BundleRequest или настроенном в DocumentTemplate)
filled_by
 filled_by string

Ключ пакета подписыватель, в который ввело значение для этого поля. Если значение поля было "initial_value", не редактируемым подписывателем, значение равно "initial". Если значение поля было значением по умолчанию, настроенным в DocumentTemplate, заполнител имеет значение default.
добрый
 kind string

Тип поля
label
 label string

Метка поля (возможно, пустая)
packet_id
 packet_id

Идентификатор пакета подписывающего элемента, который ввел значение для этого поля или null, если значение поля не было заполнено подписывателем (т. е. значением initial_value или дефекации).
value
 value

значение поля ;

Получение общего секрета веб-перехватчика

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

Получение общего секрета веб-перехватчика

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

Имя Путь Тип Описание
create_date
 create_date date-time
secret
 secret b58

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

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

Получение пакета по slug

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

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

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

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

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

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

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

Имя Путь Тип Описание
array of object
Истекает
 expires string

Время истечения срока действия ссылки в формате ISO 8601
file_url
 file_url string

URL-адрес, из которого можно скачать файл

Получение человека

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

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

Параметры

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

Идентификатор, который однозначно идентифицирует пользователя

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

Имя Путь Тип Описание
channels
 channels array of object
электронная почта
 channels.email email
id
 channels.id uuid
добрый
 channels.kind string

em для электронной почты. mp для телефона.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

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

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

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

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
 templateId True uuid

Идентификатор, который однозначно идентифицирует шаблон

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

Имя Путь Тип Описание
столбцов
 fields array of

Массив полей, размещенных в документе. Обратите внимание, что поля DocumentTemplate немного отличаются от полей DocumentRequest, а default_valueeditor_roles не initial_value и editors.
file_url
 file_url string

URL-адрес исходного файла, который служит основой для этого шаблона
is_shared
 is_shared boolean

Значение true, если шаблон документа предоставлен общий доступ. Неверно иначе
имя
 name string

Имя документа. По умолчанию имя файла или документ, когда он был отправлен, но может быть задано понятное для человека имя.
roles
 roles array of object
key
 roles.key string

Строка, уникальная для этого документа, которая идентифицирует эту роль
label
 roles.label string

Человеческая метка для этой роли

Создание URL-адреса внедренной подписи

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

Создание URL-адреса, который можно использовать для внедренной подписи

Параметры

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

Слизь, который однозначно идентифицирует пакет

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

Имя Путь Тип Описание
Истекает
 expires date-time

Метка времени, указывающая, когда срок действия URL-адреса истекает
URL-адрес
 url string

URL-адрес, который можно использовать для внедренной подписи

Создание веб-перехватчика

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

Создание нового веб-перехватчика

Параметры

Имя Ключ Обязательно Тип Описание
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

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

Имя Путь Тип Описание
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
имя
 extra_headers.name string

должен соответствовать RFC 7230
заказ
 extra_headers.order integer
value
 extra_headers.value string

должен соответствовать RFC 7230
веб-перехватчик
 extra_headers.webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

Создание веб-перехватчикаExtraHeader

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

Создание нового заголовка веб-перехватчика

Параметры

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

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

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

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

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

Создание пакета

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

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

Параметры

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

Текст JSON, определяющий созданный пакет

Создание человека

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

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

Параметры

Имя Ключ Обязательно Тип Описание
электронная почта
 email email
id
 id uuid
добрый
 kind string

em для электронной почты. mp для телефона.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

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

Имя Путь Тип Описание
channels
 channels array of object
электронная почта
 channels.email email
id
 channels.id uuid
добрый
 channels.kind string

em для электронной почты. mp для телефона.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

Список пакетов

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

Возвращает список пакетов с разбивкой на страницы в учетной записи, упорядоченный по дате создания (от последней до последней до последней). Управление разбивкой на страницы можно с помощью парамататоров разбиения на страницы (см. обзор-разбиение> на страницы). Параматизаторы фильтров запроса могут объединяться, например /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention. При объединении фильтров возвращаются только пакеты, соответствующие всем фильтрам.

Параметры

Имя Ключ Обязательно Тип Описание
Поисковый запрос
 search string

Поисковый запрос. Будут возвращены только пакеты, соответствующие поиску. Выполняется поиск следующих данных в пакете:

  • пакет slug
  • Метка пакета
  • пакет custom_key
  • имя подписыватель
  • сообщение электронной почты для подписыватель
  • телефоны подписыватель

Например. /bundles/?search=foobar@example.com
Состояние пакета
 status string

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

  • dr: Черновик - пакет еще не отправлен
  • se: Sent - пакет был отправлен, но еще не запущен подписывателями
  • st. Начало работы — по крайней мере один подписыватель начал просматривать документы.
  • co: Complete — все подписи завершили проверку или подпись
  • ca: Отменено — пакет был отменен
  • например: истек срок действия пакета до завершения
  • fa: сбой — произошла ошибка, и не удалось создать или завершить пакет

Например. /bundles/?status=co
Список состояния пакета
 status__in string

Ограничить пакеты одним из указанных состояний. Состояния должны быть разделены запятыми. Например. /bundles/?status=co,se,st
Тег пакета
 tag string

Возвращает пакеты с заданным тегом. Например. /bundles/?tag=some-tag
Список тегов пакета
 tag__in string

Возвращает пакеты, имеющие по крайней мере один из указанных тегов. Теги должны быть разделены запятыми. Например. /bundles/?tag=some-tag,another-tag
Порядок сортировки пакета
 ordering string

Управление порядком сортировки пакетов. Префикс с "-" для отмены порядка сортировки. По умолчанию пакеты сортируются по "созданным", т. е. дата создания пакета от большинства до последней.

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

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

Список персон

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

Получите список лиц в вашей учетной записи. При необходимости можно отфильтровать список, предоставив поисковый запрос. Например, для поиска всех лиц с именем "Джон", вы будете использовать запрос search=John.

Параметры

Имя Ключ Обязательно Тип Описание
Поисковый запрос
 search string

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

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

Имя Путь Тип Описание
array of object
channels
 channels array of object
электронная почта
 channels.email email
id
 channels.id uuid
добрый
 channels.kind string

em для электронной почты. mp для телефона.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

Список шаблонов документов

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

Вывод списка всех шаблонов документов

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

Имя Путь Тип Описание
столбцов
 fields array of

Массив полей, размещенных в документе. Обратите внимание, что поля DocumentTemplate немного отличаются от полей DocumentRequest, а default_valueeditor_roles не initial_value и editors.
file_url
 file_url string

URL-адрес исходного файла, который служит основой для этого шаблона
is_shared
 is_shared boolean

Значение true, если шаблон документа предоставлен общий доступ. Неверно иначе
имя
 name string

Имя документа. По умолчанию имя файла или документ, когда он был отправлен, но может быть задано понятное для человека имя.
roles
 roles array of object
key
 roles.key string

Строка, уникальная для этого документа, которая идентифицирует эту роль
label
 roles.label string

Человеческая метка для этой роли

Удаление webhookExtraHeader

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

Удаление webhookExtraHeader

Параметры

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

Идентификатор, который однозначно идентифицирует WebhookExtraHeader

Удаление веб-перехватчика

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

Удаление веб-перехватчика по идентификатору

Параметры

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

Идентификатор, который однозначно идентифицирует веб-перехватчик

Удаление пользователя

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

Удаление человека. Это также приведет к удалению любого связанного пользователя BlueInk.

Параметры

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

Идентификатор, который однозначно идентифицирует пользователя

Удаление тегов из пакета

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

Удаление тегов из пакета. Если тег в запросе не существует в пакете, он игнорируется.

Параметры

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

Слизь, который однозначно идентифицирует пакет
tags
 tags array of string

Массив тегов

Частично обновите пользователя

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

Частично обновите пользователя новыми данными.

Чтобы добавить новый адрес электронной почты или телефон в Person, включите ContactChannel в массив "каналы" без идентификатора.

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

Если ContactChannel не содержит идентификатор, но электронная почта (или телефон) соответствует существующему ContactChannel, то этот contactChannel не будет изменен.

Параметры

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

Идентификатор, который однозначно идентифицирует пользователя
электронная почта
 email email
id
 id uuid
добрый
 kind string

em для электронной почты. mp для телефона.
phone
 phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

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

Имя Путь Тип Описание
channels
 channels array of object
электронная почта
 channels.email email
id
 channels.id uuid
добрый
 channels.kind string

em для электронной почты. mp для телефона.
phone
 channels.phone phone
id
 id uuid
is_user
 is_user boolean

Значение true, если этот пользователь связан с пользователем BlueInk
metadata
 metadata object

Метаданные для связывания с этим человеком. Метаданные можно использовать в SmartFill для автоматического заполнения документов. Дополнительные сведения см. в документации по SmartFill.
имя
 name string

Имя пользователя

Частичное обновление webhookExtraHeader

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

Частично обновите WebhookExtraHeader новыми данными.

Параметры

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

Идентификатор, который однозначно идентифицирует WebhookExtraHeader
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

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

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

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid

Частичное обновление веб-перехватчика

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

Частично обновите веб-перехватчик новыми данными.

Параметры

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

Идентификатор, который однозначно идентифицирует веб-перехватчик
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
id
 id uuid
имя
 name string

должен соответствовать RFC 7230
заказ
 order integer
value
 value string

должен соответствовать RFC 7230
веб-перехватчик
 webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https

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

Имя Путь Тип Описание
enabled
 enabled boolean
event_types
 event_types array of string

типы событий, которые будут запускать веб-перехватчик
extra_headers
 extra_headers array of object
id
 extra_headers.id uuid
имя
 extra_headers.name string

должен соответствовать RFC 7230
заказ
 extra_headers.order integer
value
 extra_headers.value string

должен соответствовать RFC 7230
веб-перехватчик
 extra_headers.webhook uuid
id
 id uuid
JSON (формат обмена данными JavaScript)
 json boolean
URL-адрес
 url url

должен быть полным URL-адресом, включая http/https