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

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

 

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

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

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

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

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

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

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

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

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

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

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

  • Имя: желательно выбрать удобное имя, которое могут легко понять другие администраторы.
  • Область: насколько широк диапазон действия веб-перехватчика? В интерфейсе доступны «Учетная запись» и «Группа».
    • 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_UNSHARE
Доступ к соглашению отменен автоматически AGREEMENT_UNSHARE_AUTO
Соглашение передано AGREEMENT_ACTION_DELEGATED
Участник соглашения заменен AGREEMENT_ACTION_REPLACED_SIGNER
Соглашение изменено AGREEMENT_MODIFIED
Изменение соглашения подтверждено AGREEMENT_USER_ACK_AGREEMENT_MODIFIED
Сообщение электронной почты с соглашением просмотрено AGREEMENT_EMAIL_VIEWED
Сообщение электронной почты с соглашением возвращено AGREEMENT_EMAIL_BOUNCED
Документы соглашения просмотрены AGREEMENT_DOCUMENTS_VIEWED
Документ соглашения просмотрен при использовании пароля для просмотра документа AGREEMENT_DOCUMENTS_VIEWED_PASSWORD_PROTECTED
Не удалось создать соглашение AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM
Соглашение синхронизировано после события в автономном режиме AGREEMENT_OFFLINE_SYNC
Соглашение помещено в хранилище AGREEMENT_VAULTED
Участник соглашения прошел аутентификацию с помощью учетной записи в социальных сетях AGREEMENT_WEB_IDENTITY_AUTHENTICATED
Участник соглашения прошел аутентификацию на основе знаний AGREEMENT_KBA_AUTHENTICATED
Участник соглашения выполнил аутентификацию с помощью одноразового пароля по эл. почте
AGREEMENT_EMAIL_OTP_AUTHENTICATED
Срок действия соглашения обновлен AGREEMENT_EXPIRATION_UPDATED
Напоминание о соглашении отправлено AGREEMENT_REMINDER_SENT
Лицо, пописывающее соглашение, изменено другим лицом AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER
Инициировано напоминание о соглашении AGREEMENT_REMINDER_INITIATED
   
Веб-перехватчики соглашения доступны только через API
Элемент UI Название веб-перехватчика
Н/П
AGREEMENT_READY_TO_NOTARIZE
Н/П
AGREEMENT_READY_TO_VAULT

 

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

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

 

Веб-формы:

Элемент 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-файл.
      • Применяется к событиям Процесс работы с соглашением завершен и Все события соглашений.
  • Пакетная отправка
    • Сведения о пакетной отправке: подробная информация об объекте Пакетной отправки, который вызвал срабатывание события.
  • Веб-форма
    • Сведения о виджете: подробная информация о веб-форме, которая активировала событие.
    • Сведения о документах виджета: информация о документах, связанных с шаблоном веб-формы.
    • Сведения об участнике виджета: информация об участниках, работающих в шаблоне веб-формы.

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

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