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

Настройка веб-перехватчиков

Обзор

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

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

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

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

 

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

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

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

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

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

Прежде всего администраторам потребуется служба веб-перехватчиков, готовая принимать входящие 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-адрес веб-перехватчика, пока не будет исчерпано заданное максимальное число попыток.

Параметры конфигурации

Для настройки веб-перехватчика нужно определить пять элементов:

  • Имя: желательно выбрать удобное имя, которое могут легко понять другие администраторы.
  • Область: насколько широк диапазон действия веб-перехватчика? В интерфейсе доступны «Учетная запись» и «Группа».
    • API поддерживает области «Учетная запись», «Группа», «Пользователь» и «Ресурс».
    • Можно определить только одну область на один веб-перехватчик.
  • URL-адрес: целевой URL-адрес, на который приложение Acrobat Sign передало полезные данные JSON.
  • События: факторы, вызывающие создание JSON в Acrobat Sign и его передачу на URL-адрес.
    • Каждое событие создает различный набор полезных данных для переключающего события.
    • В один веб-перехватчик можно включить несколько событий .
  • Параметры уведомления: параметры уведомления определяют разделы полезных данных События в формате JSON, что позволяет выбрать только важные разделы из События для конкретного веб-перехватчика (то есть сократить объем ненужных данных, передаваемых на URL-адрес).

После окончания определения веб-перехватчика нажмите Сохранить, и новый веб-перехватчик немедленно начнет реагировать на переключающие события.

Примечание.

Настройте URL-адрес веб-перехватчика, чтобы он отвечал на запросы на проверку и уведомления о веб-перехватчике в соответствии с описанным выше протоколом проверки. Идентификатор клиента (идентификатор приложения), который будет отправлен на веб-перехватчики, созданные из веб-приложения Acrobat Sign, — UB7E5BXCXY.

Настройка веб-перехватчика



Области применения

  • Учетная запись: все события с подпиской в учетной записи приводят к отправке push-уведомлений.
    • Администраторы учетных записей имеют право просматривать все веб-перехватчики, определенные для учетной записи и всех ее групп.
  • Группа: все события с подпиской в группе приводят к отправке push-уведомления. ВНИМАНИЕ: веб-перехватчики с областью групп существуют только для одной группы.
    • Администраторы групп видят только веб-перехватчики, ассоциированные с конкретной группой. Они не будут видеть веб-перехватчики на уровне учетной записи или привязанные к другим группам.
    • Учетные записи, для которых включена поддержка пользователей в нескольких группах, будут видеть параметр для настройки группы, к которой нужно применить область.
  • Учетная запись пользователя: все события учетной записи пользователя, на которые оформлена подписка, приводят к отправке push-уведомлений. Веб-перехватчики на уровне пользователя можно создать только через API.
  • Веб-перехватчик на уровне ресурса: создается для конкретного ресурса. События, относящиеся к этому ресурсу, будут отправляться на URL-адрес веб-перехватчика. Веб-перехватчики на уровне ресурса можно создать только через API.

URL-адрес

URL-адрес веб-перехватчика — это сервер, который прослушивает входящие уведомления HTTPS POST, отправляемые при наступлении событий.

Этот URL-адрес нужен для подписки веб-перехватчика на события.

  • Клиент должен предоставлять URL-адрес HTTPS, на который Acrobat Sign может отправлять сообщения POST. Этот URL-адрес должен быть доступен в интернете.  
    • Например, URI-адреса 127.0.0.1 и localhost работать не будут.
    • Конечные точки URL-адреса должны прослушивать порты 443 или 8443 (решение клиента при определении URL-адреса для обратного вызова).
  • Убедитесь, что веб-перехватчик поддерживает запросы POST для уведомлений о входящих событиях и запросы GET для запросов на проверку.
  • URL-адрес не должен блокироваться брандмауэром.


События

Ниже представлены события, которые приводят к отправке push-уведомлений на URL-адрес веб-перехватчика, сгруппированные по объекту и перечисленные в порядке, указанном в пользовательском интерфейсе.

Значение слева — это значение, которое можно видеть в пользовательском интерфейсе Acrobat Sign. Значение справа — это название веб-перехватчика в API.

Подробная информация о веб-перехватчиках и полезных данных представлена в Руководстве разработчика Acrobat Sign.

Соглашения:

Элемент UI Название веб-перехватчика
Все события соглашения AGREEMENT_ALL
Соглашение создано AGREEMENT_CREATED
Соглашение отправлено AGREEMENT_ACTION_REQUESTED
Участник соглашения выполнил действие AGREEMENT_ACTION_COMPLETED
Процесс работы с соглашением завершен AGREEMENT_WORKFLOW_COMPLETED
Срок действия соглашения истек AGREEMENT_EXPIRED
Соглашение удалено AGREEMENT_DOCUMENTS_DELETED
Соглашение отменено AGREEMENT_RECALLED
Соглашение отклонено AGREEMENT_REJECTED
Доступ к соглашению предоставлен AGREEMENT_SHARED
Соглашение передано AGREEMENT_ACTION_DELEGATED
Участник соглашения заменен AGREEMENT_ACTION_REPLACED_SIGNER
Соглашение изменено AGREEMENT_MODIFIED
Изменение соглашения подтверждено AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Сообщение электронной почты с соглашением просмотрено AGREEMENT_EMAIL_VIEWED
Сообщение электронной почты с соглашением возвращено AGREEMENT_EMAIL_BOUNCED
Не удалось создать соглашение AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Соглашение синхронизировано после события в автономном режиме AGREEMENT_OFFLINE_SYNC
Соглашение загружено отправителем AGREEMENT_UPLOADED_BY_SENDER
Соглашение помещено в хранилище AGREEMENT_VAULTED
Участник соглашения прошел аутентификацию с помощью учетной записи в социальных сетях AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Участник соглашения прошел аутентификацию на основе знаний AGREEMENT_KBA_AUTHENTICATED
Напоминание о документе отправлено AGREEMENT_REMINDER_SENT
Лицо, пописывающее соглашение, изменено другим лицом AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
   
Веб-перехватчики документа доступны только через API
Н/П AGREEMENT_EXPIRATION_UPDATED
Н/П
AGREEMENT_READY_TO_NOTARIZE
Н/П
AGREEMENT_READY_TO_VAULT

 

Пакетная отправка:

Элемент UI Название веб-перехватчика
Все события пакетной отправки MEGASIGN_ALL
Пакетная отправка создана
MEGASIGN_CREATED
Общий доступ к пакетной отправке предоставлен
MEGASIGN_SHARED
Пакетная отправка отозвана
MEGASIGN_RECALLED

 

Веб-формы:

Элемент UI Название веб-перехватчика
Все события веб-формы WIDGET_ALL
Веб-форма создана
WIDGET_CREATED
Веб-форма включена
WIDGET_ENABLED
Веб-форма отключена
WIDGET_DISABLED
Веб-форма изменена
WIDGET_MODIFIED
Предоставлен общий доступ к веб-форме
WIDGET_SHARED
Не удалось создать веб-форму
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM

 

Шаблоны библиотеки (только API):

Элемент UI Название веб-перехватчика
Н/П LIBRARY_DOCUMENT_ALL
Н/П LIBRARY_DOCUMENT_CREATED
Н/П LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Н/П LIBRARY_DOCUMENT_MODIFIED

 

Параметры уведомлений

Параметры уведомлений позволяют настраивать полезные данные JSON только для определенных элементов события.

Например, в событии Участник соглашения заменен вам могут понадобиться только Сведения о соглашении и Информация об участнике соглашения, а Сведения о соглашении вы можете исключить, что позволит сократить общий объем данных, передаваемых на URL-адрес вашего веб-перехватчика.

 

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

Двусторонняя аутентификация по протоколу SSL

Двусторонний протокол SSL, часто называемый Client-Side SSL или взаимный TLS, — это такой протокол SSL, в котором как сервер, так и клиент (веб-браузер) для своей идентификации представляют сертификаты.

Администраторы учетных записей могут настроить сертификат на стороне клиента на странице Параметры безопасности.

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

Используйте двусторонний протокол SSL для аутентификации клиента (Acrobat Sign) и службы прослушивания, чтобы гарантировать, что только Acrobat Sign сможет получить доступ к URL-адресу веб-перехватчика. 

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

Ниже приведены наиболее распространенные вопросы как для процесса проверки веб-сервера, так и для проверки сертификации клиента.

Проверка веб-сервера

Во время регистрации веб-перехватчика Acrobat Sign проверяет URL-адрес сервера веб-перехватчика.

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

Проверка сертификата клиента

Как включить или отключить функцию

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

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

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

Активация веб-перехватчика

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

На странице веб-перехватчиков в Acrobat Sign вы увидите активные веб-перехватчики по умолчанию.

Для активации неактивного веб-перехватчика:

  • Щелкните на иконке Параметры (три горизонтальные линии) справа от строки заголовка веб-перехватчиков Показать все веб-перехватчики

 

  • Щелкните один раз на неактивном веб-перехватчике, чтобы его выбрать.
    • Этим действием вы раскроете параметры веб-перехватчика прямо под строкой заголовка.
  • Нажмите кнопку Активировать

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

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

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

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

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

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

Изменять можно только События и Параметры уведомлений.

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

Для изменения параметров веб-перехватчика:

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

 

  • Внесите нужные изменения и нажмите Сохранить

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

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

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

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

Для удаления веб-перехватчика:

  • Перейдите на страницу веб-перехватчиков
  • Выберите веб-перехватчик, который хотите удалить, щелкнув на нем один раз.
  • Щелкните Удалить под строкой заголовка
  • Вам будет предложено подтвердить удаление. Нажмите ОК.

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

  • Подпишитесь на конкретные события, чтобы ограничить количество запросов 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, то есть любой пользователь получит доступ к соглашению только с того момента, когда начнется участие этого пользователя в соглашении.

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

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

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

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

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

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

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

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