Пример кода Javascript для получения идентификатора клиента, проверки и последующего возвращения в заголовке ответа
Руководство пользователя Adobe Acrobat Sign
Новые возможности
Начало работы
- Краткое руководство для администраторов
- Краткое руководство для пользователей
- Библиотека видеоуроков
- Часто задаваемые вопросы
Администрирование
- Обзор Admin Console
-
Управление пользователями
- Добавление пользователей
- Создание пользователей, ориентированных на функции
- Проверка пользователей с ошибками подготовки
- Изменение имени и адреса электронной почты
- Изменение участия в группе
- Повышение роли пользователя до роли администратора
- Типы идентификаторов пользователей и единый вход
- Смена удостоверения пользователя
- Аутентификация пользователей с помощью Microsoft Azure
- Аутентификация пользователей с помощью Google Federation
- Профили продуктов
- Интерфейс входа
-
Параметры учетной записи/группы
- Обзор параметров
-
Глобальные настройки
- Новый интерфейс для получателей
- Рабочие процессы самостоятельного подписания
- Пакетная отправка
- Веб-формы
- Рабочие процессы Power Automate
- Документы библиотеки
- Сбор данных формы с соглашениями
- Ограниченная видимость документа
- Прикрепление копии подписанного соглашения в формате PDF
- Добавление ссылки в сообщение электронной почты
- Добавление изображения в сообщение электронной почты
- Файлы, прикрепленные к электронному письму, получат имя
- Прикрепление отчета об аудите к документам
- Объединение нескольких документов в один
- Загрузка отдельных документов
- Добавление подписанного документа
- Установка часового пояса по умолчанию
- Пользователи, состоящие в нескольких группах (UMG)
- Разрешения администратора группы
- Замена получателя
- Отчет об аудите
- Нижний колонтитул транзакции
- Клиент в области здравоохранения
- Настройка учетной записи
-
Настройки подписи
- Корректно отформатированные подписи
- Пользовательские условия использования и соглашение о неразглашении
- Перемещение между получателями по полям форм
- Перезапуск процесса работы с документом
- Отклонение подписания
- Предоставление подписывающим сторонам разрешения на печать и размещение рукописной подписи
- Добавление требования о том, чтобы подписанты использовали мобильное устройство для создания подписи
- Запрос IP-адресов подписантов
- Цифровые подписи
- Электронные печати
- Цифровое удостоверение
-
Параметры отчета
- Параметры безопасности
-
Параметры отправки
- Добавление требования о вводе имени получателя при отправке
- Блокировка значений имени для известных пользователей
- Допустимые роли получателей
- Разрешение электронного заверения
- Группы получателей
- Получатели в копии
- Доступ получателя к соглашению
- Сведение полей
- Изменение соглашений
- Личные сообщения
- Разрешенные типы подписей
- Напоминания
- Отправлять уведомления о соглашении через
- Параметры идентификации подписывающей стороны
- Защита контента
- Порядок подписания
- Режим Liquid Mode
- Требования биофармацевтической отрасли
- Настройки нотариального заверения
- Интеграция платежной системы
- Параметры SAML
- Управление данными
- Настройки меток времени
- Внешний архив
- Языки учетной записи
- Параметры эл. почты
- Переход с домена с echosign.com на adobesign.com
- Настройка параметров для получателей
-
Руководство по нормативным требованиям
- Специальные возможности
- Закон об ответственности и переносе данных о страховании здоровья граждан (HIPAA)
- Общий регламент по защите данных (GDPR)
- 21 CFR, часть 11 и приложение EudraLex 11
- Клиенты в области здравоохранения
- Поддержка IVES
- Хранящиеся соглашения
- Рекомендации для ЕС и Великобритании
- Подтверждение домена
- Ссылки на сообщения о нарушениях
Отправка, подписание соглашений и управление ими
-
Параметры получателя
- Отменить уведомления по электронной почте
-
Параметры на странице эл. подписания
- Параметры на странице эл. подписания
- Открытие для чтения соглашения без полей
- Отказ от подписания соглашения
- Передача полномочий по подписанию
- Загрузка PDF-файл соглашения
- Просмотр истории соглашения
- Просмотр сообщений о соглашении
- Преобразование электронной подписи в рукописную
- Преобразование рукописной подписи в электронную
- Навигация по полям формы
- Очистка полей формы
- Увеличение страниц электронного документа и навигация по ним
- Изменение языка, используемого в инструментах соглашения и сведениях о нем
- Просмотр юридической информации
- Настройка параметров файлов cookie Acrobat Sign
- Отправка соглашений
-
Создание полей в документах
- Среда авторинга внутри приложения
- Создание форм и текстовых тегов
- Создание форм с помощью Acrobat (AcroForms)
- Поля
- Часто задаваемые вопросы об авторинге
- Подписание соглашений
-
Управление соглашениями
- Управление видом страницы
- Передача соглашений
- Замена получателей
- Ограниченная видимость документа
- Отмена соглашения
- Создание новых напоминаний
- Просмотр напоминаний
- Отмена напоминания
- Доступ к потокам Power Automate
-
Другие действия...
- Как работает поиск
- Просмотр соглашения
- Создание шаблона на основе соглашения
- Скрытие/отображение соглашений в представлении
- Добавление подписанного соглашения
- Изменение файлов или полей в отправленном соглашении
- Изменение метода аутентификации получателя
- Добавление или изменение срока действия
- Добавление примечания к соглашению
- Предоставление доступа к отдельному соглашению
- Отмена доступа к соглашению
- Загрузка отдельного соглашения
- Загрузка отдельных файлов соглашения
- Загрузка отчета об аудите для соглашения
- Загрузка содержимого полей для соглашения
- Отчет об аудите
- Отчеты и экспорт данных
Расширенные возможности и рабочие процессы для работы с соглашениями
- Веб-формы
-
Шаблоны для повторного использования
- Формы государственных учреждений США в библиотеке Acrobat Sign
- Создание шаблона библиотеки
- Изменение имени шаблона библиотеки
- Изменение типа шаблона библиотеки
- Изменение уровня доступа к шаблону библиотеки
- Копирование, редактирование и сохранение общего шаблона
- Загрузка данных для агрегированного поля в шаблоне библиотеки
- Передача прав владения веб-формами и шаблонами библиотек
-
Рабочие процессы Power Automate
- Обзор интеграции с Power Automate и включенных в нее прав
- Включение интеграции Power Automate
- Контекстные действия на странице «Управление»
- Отслеживание использования Power Automate
- Создание потока (с примерами)
- Триггеры, используемые для потоков
- Импорт потоков извне Acrobat Sign
- Управление потоками
- Редактирование потоков
- Общий доступ к потокам
- Отключение и включение потоков
- Удаление потоков
-
Полезные шаблоны
- Только администратор
- Архивирование соглашений
- Архивирование соглашений веб-форм
- Извлечение данных соглашения
- Уведомления о соглашениях
- Создание соглашения
- Настраиваемые рабочие процессы отправки
- Предоставление доступа к пользователям и соглашениям
Интеграция с другими продуктами
- Acrobat Sign для Salesforce
- Acrobat Sign для Microsoft
- Другие интеграции
- Интеграции, управляемые партнерами
- Как получить ключ интеграции?
Разработчик Acrobat Sign
- Интерфейсы REST API
Поддержка и устранение неполадок
Обзор
Веб-перехватчик — это определяемый пользователем запрос 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 одновременных запросов на создание веб-перехватчиков. |
Уведомление веб-перехватчика/обратного вызова |
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-адрес более не будут отправляться уведомления, пока администратор не включит веб-перехватчик снова.
Все уведомления за период, пока веб-перехватчик находится в отключенном состоянии, будут потеряны.