Руководство пользователя Отмена

Обзор веб-перехватчика Acrobat Sign

 

Руководство пользователя Adobe Acrobat Sign

Новые возможности

Начало работы

Администрирование

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

Расширенные возможности и рабочие процессы для работы с соглашениями

Интеграция с другими продуктами

Разработчик Acrobat Sign

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

Обзор

Веб-перехватчик — это определяемый пользователем запрос HTTPS, который запускается при возникновении события с подпиской на исходном сайте (в данном случае — Adobe Acrobat Sign).

Итак, веб-перехватчик — это служба REST, принимающая пакет или поток данных.

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

При запуске события с подпиской Acrobat Sign создает запрос HTTPS POST с JSON-текстом и доставляет его по указанному URL-адресу.

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

 

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

  • Администраторы могут включать собственные веб-перехватчики, не привлекая службу поддержки Acrobat Sign для создания списка URL-адресов обратных вызовов.
  • Веб-перехватчики лучше обеспечивают актуальность данных, эффективность коммуникации и безопасность. Не требуется регулярный опрос данных.
  • Веб-перехватчики позволяют с легкостью использовать разные уровни области применения (учетная запись/группа/пользователь/ресурс). 
  • Веб-перехватчики — это более современное решение для API, которое упрощает настройку современных приложений.
  • Для каждой области (учетная запись/группа/пользователь/ресурс) можно настроить несколько веб-перехватчиков, тогда как обратные вызовы должны быть уникальными.
  • Веб-перехватчики позволяют выбирать данные для возврата, в то время как обратный вызов работает по принципу «все или ничего».
  • Можно настроить, какие метаданные (только основные или подробные) может передавать веб-перехватчик.
  • Поскольку пользовательский интерфейс полностью контролируется администратором, веб-перехватчики намного проще создавать, редактировать или отключать по мере необходимости.
Примечание.

Этот документ в основном посвящен пользовательскому интерфейсу веб-перехватчиков в веб-приложении Acrobat Sign (ранее Adobe Sign).

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

Необходимые требования

Для работы службы необходимо разрешить диапазоны IP-адресов для веб-перехватчиков с помощью сетевой безопасности

Устаревшая служба URL-адресов обратного вызова в REST версии 5 использует те же диапазоны IP-адресов, что и служба веб-перехватчика.

Администраторы могут входить в Adobe Admin Console для добавления пользователей. После входа в систему перейдите к меню администратора и прокрутите вниз до пункта Веб-перехватчики.

Способ применения

Прежде всего администраторам потребуется служба веб-перехватчиков, готовая принимать входящие push-уведомления от Acrobat Sign. Здесь есть множество вариантов, и веб-перехватчик будет успешно работать с любой службой, которая умеет принимать запросы POST и GET.

После запуска службы администратор Acrobat Sign может создать новый веб-перехватчик в интерфейсе веб-перехватчика в меню «Учетная запись» на сайте Acrobat Sign.

Администраторы могут настроить запуск веб-перехватчика для событий документа, веб-формы (виджет) или массовой отправки (MegaSign). Шаблон библиотеки (документ библиотеки) также можно настроить через API.

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

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

После настройки и сохранения веб-перехватчика Acrobat Sign будет отправлять новый JSON-объект по указанному URL-адресу при каждом срабатывании события с подпиской. Если вы не хотите менять критерии переключающего события или полезную нагрузку JSON, никаких манипуляций с веб-перехватчиком выполнять не нужно.

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

Перед завершением регистрации веб-перехватчика Acrobat Sign проверяет, действительно ли указанный в запросе на регистрацию URL-адрес веб-перехватчика предназначен для получения уведомлений. Поэтому когда Acrobat Sign получает запрос на регистрацию нового веб-перехватчика, он сначала отправляет запрос проверки по URL-адресу веб-перехватчика. Он представляет собой запрос HTTPS GET, отправляемый на URL-адрес веб-перехватчика. Этот запрос имеет собственный HTTP-заголовок X-AdobeSign-ClientId. Значение в этом заголовке установлено для идентификатора клиента API-приложения (идентификатора приложения), которое запрашивает создание/регистрацию веб-перехватчика. Для успешной регистрации веб-перехватчика его URL-адрес должен ответить на этот запрос проверки, используя код ответа 2XX, А ТАКЖЕ должен отправить одно и то же значение идентификатора клиента одним из следующих двух способов:

  • В заголовке ответа X-AdobeSign-ClientId. Это тот же заголовок, который передан в запросе и должен быть возвращен при ответе.
  • Либо в тексте ответа JSON с ключом xAdobeSignClientId, значением которого является тот же идентификатор клиента, который отправлен в запросе.

Веб-перехватчик будет зарегистрирован только при успешном ответе (код ответа 2XX) и после проверки идентификатора клиента либо в заголовке, либо в тексте ответа. Цель этого запроса проверки — убедиться в том, что URL-адрес веб-перехватчика действительно готов получать уведомления на указанный URL-адрес. Если вы случайно введете неверный URL-адрес, он не будет правильно отвечать на запрос проверки намерения, и Acrobat Sign не станет отправлять уведомления на этот URL-адрес. URL-адрес веб-перехватчика также может подтвердить, что уведомления будут получаться только через веб-перехватчики, зарегистрированные конкретным приложением. Это выполняется путем проверки идентификатора клиента приложения, переданного в заголовке X-AdobeSign-ClientId. Если URL-адрес веб-перехватчика не распознает идентификатор клиента, он НЕ БУДЕТ отсылать ответный код об успешном выполнении операции, а Acrobat Sign позаботится о том, чтобы этот URL-адрес не был зарегистрирован в качестве веб-перехватчика.

Проверка вызова URL-адреса веб-перехватчика будет выполняться при следующих сценариях:

  • Регистрация веб-перехватчика. Веб-перехватчик не будет создан, если проверка URL-адреса веб-перехватчика не завершена.
  • Обновление веб-перехватчика с НЕАКТИВНОГО на АКТИВНЫЙ. Если проверка URL-адреса веб-перехватчика не завершится, состояние веб-перехватчика не будет изменено на АКТИВНОЕ.

Как ответить на уведомление веб-перехватчика

Acrobat Sign выполняет неявную проверку намерений в каждом запросе уведомления веб-перехватчика, отправляемом на его URL-адрес. Таким образом, каждый HTTPS-запрос уведомления веб-перехватчика также содержит настраиваемый HTTP-заголовок X-AdobeSign-ClientId. Значением в этом заголовке является идентификатор клиента (идентификатор приложения) того приложения, которое создало веб-перехватчик. Уведомление веб-перехватчика будет считаться доставленным, только если будет возвращен успешный ответ (код ответа 2XX), а идентификатор клиента будет отправлен либо в заголовке HTTP (X-AdobeSign-ClientId), либо в тексте ответа JSON с ключом xAdobeSignClientId и значением идентификатора клиента. В противном случае мы будем повторять попытки доставить уведомление на URL-адрес веб-перехватчика, пока не будет исчерпано заданное максимальное число попыток.

Включение и отключение функции

Доступ к функции веб-перехватчиков для учетных записей корпоративного уровня включен по умолчанию.

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

Доступ к странице Веб-перехватчики можно получить через панель слева в меню администратора.

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

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

Для создания веб-перехватчика (и обратного вызова) и событий уведомления ограничено количество одновременных уведомлений, отправляемых клиенту системой Acrobat Sign. Ограничение применяется к учетной записи для включения всех групп в ней.
Этот тип ограничения скорости позволяет предотвратить чрезмерное потребление плохо разработанной учетной записью ресурсов сервера, что в итоге оказывает негативное влияние на всех остальных клиентов в этой среде сервера.

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

Действие
(Событие)

Макс. кол-во
одновременных
событий

Описание

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

10

Для каждой учетной записи разрешено не более 10 одновременных запросов на создание веб-перехватчиков.
В случае превышения этого лимита будет получен ответ с кодом 429 TOO_MANY_REQUESTS.

Уведомление веб-перехватчика/обратного вызова

30

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

Рекомендации

  • Подпишитесь на конкретные события, чтобы ограничить количество запросов HTTPS к серверу. Чем более конкретны ваши веб-перехватчики, тем меньший объем информации будет необходимо обрабатывать.
  • Устойчивость к дублированию. Если у вас больше одного приложения, использующего один и тот же URL-адрес веб-перехватчика, и с каждым приложением сопоставлен один и тот же пользователь, одно и то же событие будет отправляться на ваш веб-перехватчик несколько раз (по одному разу для каждого приложения). В некоторых случаях ваш веб-перехватчик может получать дубликаты событий. Ваше приложение веб-перехватчика должно относиться к этому спокойно и выполнять дедупликацию по идентификатору события.
  • Быстрый ответ веб-перехватчику. У приложения есть всего пять секунд для ответа на запрос веб-перехватчика. В случае запроса на проверку это не проблема, поскольку вашему приложению не нужно выполнять никакой реальной работы для ответа. В случае запросов уведомления вашему приложению понадобится выполнить ряд действий для ответа на запрос. Рекомендуется работать либо в отдельной ветке или асинхронно при помощи очереди, чтобы ответ отправлялся в течение 5 секунд.
  • Управление одновременным выполнением. Когда пользователь быстро вносит несколько изменений, приложение может почти одновременно получить несколько уведомлений о действиях одного пользователя. Если вы не будете следить за параллельным доступом, ваше приложение может обрабатывать одни и те же изменения для каждого пользователя несколько раз. Чтобы пользоваться преимуществами веб-перехватчиков Acrobat Sign, важно четко понимать правила использования информации. Обязательно задайте себе следующие вопросы:
    • Какие данные являются полезными при ответе?
    • Кто получит доступ к этой информации?
    • Какие решения и какие отчеты будут создаваться по этим данным?
  • Рекомендации по получению подписанных документов. Есть несколько важных факторов, которые нужно учесть при выборе методов получения подписанных PDF от Acrobat Sign в систему управления документами.

Вполне допустимо просто выбрать вариант Документ, подписанный соглашением при создании веб-перехватчика, но вы можете также применить API Acrobat Sign для получения данных при уведомлении о создании события (например, при переходе соглашения в состояние «Готово»).

Дополнительные сведения...

Ограничения на размер кода JSON

Рабочая нагрузка JSON не может иметь размер более 10 МБ.

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

В этой ситуации в ответ включается параметр ConditionalParametersTrimmed, чтобы уведомить клиента об удалении информации conditionalParameters.

Параметр conditionalParametersTrimmed является объектом с типом массив, который содержит сведения об отброшенных ключах.

Отбрасывание применяется в следующем порядке:

  • includeSignedDocuments
  • includeParticipantsInfo
  • includeDocumentsInfo
  • includeDetailedInfo

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

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

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

Веб-перехватчики Acrobat Sign доставляют уведомления отправителю соглашения и любому веб-перехватчику, настроенному в группе, из которой отправлено соглашение. Веб-перехватчики на уровне учетной записи получают все события.

Повторная попытка при отключенной службе

Если целевой URL-адрес веб-перехватчика по какой-либо причине отключен, Acrobat Sign поместит документ JSON в очередь и будет в течение 72 часов повторять попытку отправки с нарастающими интервалами.

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

Стратегия повторной доставки уведомлений заключается в удвоении времени между попытками, начиная с 1-минутного интервала, увеличивающегося до 12 часов, что обеспечивает 15 попыток за 72 часа.

Если веб-перехватчик не отвечает в течение 72 часов и за последние 7 дней не зарегистрировано ни одной успешной доставки, этот веб-перехватчик отключается. На этот URL-адрес более не будут отправляться уведомления, пока администратор не включит веб-перехватчик снова.

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

Получайте помощь быстрее и проще

Новый пользователь?