Выполните вход в Acrobat Sign как администратор.
Руководство пользователя Adobe Acrobat Sign
Новые возможности
Начало работы
- Краткое руководство для администраторов
- Краткое руководство для пользователей
- Для разработчиков
- Библиотека видеоуроков
- Часто задаваемые вопросы
Администрирование
- Обзор Admin Console
- Управление пользователями
- Добавление, редактирование и просмотр активных пользователей
- Создание пользователей, ориентированных на функции
- Просмотр пользователей, которые не завершили процесс проверки
- Проверка пользователей с ошибками подготовки
- Изменение имени и адреса электронной почты
- Изменение участия в группе
- Изменение участия в группе с помощью интерфейса группы
- Повышение роли пользователя до роли администратора
- Типы идентификаторов пользователей и единый вход
- Смена удостоверения пользователя
- Аутентификация пользователей с помощью Microsoft Azure
- Аутентификация пользователей с помощью Google Federation
- Профили продуктов
- Интерфейс входа
- Параметры учетной записи/группы
- Обзор параметров
- Глобальные настройки
- Идентификатор и уровень учетной записи
- Новый интерфейс для получателей
- Рабочие процессы самостоятельного подписания
- Пакетная отправка
- Веб-формы
- Настраиваемые рабочие процессы отправки
- Рабочие процессы Power Automate
- Документы библиотеки
- Сбор данных формы с соглашениями
- Ограниченная видимость документа
- Прикрепление копии подписанного соглашения в формате PDF
- Добавление ссылки в сообщение электронной почты
- Добавление изображения в сообщение электронной почты
- Файлы, прикрепленные к электронному письму, получат имя
- Прикрепление отчета об аудите к документам
- Объединение нескольких документов в один
- Загрузка отдельных документов
- Добавление подписанного документа
- Делегирование для пользователей в моей учетной записи
- Предоставление права делегирования внешним получателям
- Право на подпись
- Право на отправку
- Полномочия на добавление электронных печатей
- Установка часового пояса по умолчанию
- Установка формата даты по умолчанию
- Пользователи, состоящие в нескольких группах (UMG)
- Разрешения администратора группы
- Замена получателя
- Отчет об аудите
- Нижний колонтитул транзакции
- Сообщения и инструкции в приложении
- Файлы PDF с расширенным доступом
- Рабочие процессы PDF/A
- Клиент в области здравоохранения
- Новый интерфейс запроса подписей
- Новый интерфейс настраиваемых рабочих процессов
- Новый интерфейс создания шаблонов
- Настройка учетной записи / Настройки брендинга
- Настройки подписи
- Корректно отформатированные подписи
- Предоставление получателям разрешения на добавление подписи
- Подписывающие стороны могут изменять свои имена
- Предоставление получателям разрешения на использование своих сохраненных подписей
- Пользовательские условия использования и соглашение о неразглашении
- Перемещение между получателями по полям форм
- Перезапуск процесса работы с документом
- Отклонение подписания
- Предоставление разрешения на использование штампов
- Добавление требования о том, чтобы подписывающие стороны указывали должность или название компании
- Предоставление подписывающим сторонам разрешения на печать и размещение рукописной подписи
- Отображение сообщений при электронном подписании
- Добавление требования о том, чтобы подписанты использовали мобильное устройство для создания подписи
- Запрос IP-адресов подписантов
- Исключение названия компании и должности из штампа участника
- Применение адаптивного масштаба при рисовании подписи
- Цифровые подписи
- Электронные печати
- Цифровое удостоверение
- Параметры отчета
- Включить классическую отчетность
- Новый интерфейс для работы с отчетами
- Настройки классических отчетов
- Параметры безопасности
- Параметры единого входа
- Настройки «Запомнить меня»
- Политика пароля для входа
- Надежность пароля для входа
- Продолжительность веб-сеанса
- Тип шифрования PDF
- Программный интерфейс
- Доступ к сведениям о пользователе и группе
- Допустимые диапазоны IP-адресов
- Общий доступ к учетной записи
- Полномочия на совместное использование учетных записей
- Средства управления совместным использованием соглашений
- Проверка личности подписывающей стороны
- Пароль для подписания соглашения
- Надежность пароля для документа
- Блокировка подписывающих сторон по геолокации
- Аутентификация по телефону
- Аутентификация на основе данных (KBA)
- Разрешение на извлечение страниц
- Истечение срока действия ссылки на документ
- Отправка сертификата клиента для веб-перехватчиков и обратных вызовов
- Метка времени
- Параметры отправки
- Отображение страницы отправки после входа
- Возможности создания соглашений
- Добавление требования о вводе имени получателя при отправке
- Блокировка значений имени для известных пользователей
- Допустимые роли получателей
- Разрешение электронного заверения
- Группы получателей
- Получатели в копии
- Обязательные поля
- Прикрепление документов
- Сведение полей
- Изменение соглашений
- Удаление получателей из соглашений в процессе выполнения
- Название соглашения
- Языки
- Личные сообщения
- Разрешенные типы подписей
- Напоминания
- Защита паролем для подписанных документов
- Отправка уведомлений о соглашении
- Параметры идентификации подписывающего
- Обзор
- Пароль для подписания
- Аутентификация на основе знаний
- Аутентификация по телефону
- Аутентификация через WhatsApp
- Одноразовый пароль по электронной почте
- Аутентификация Acrobat Sign
- Цифровая подпись в облаке
- Аутентификация по цифровому удостоверению
- Удостоверение личности
- Отчет по проверке личности подписывающей стороны
- Заполнение полей формы данными с подтвержденной идентификацией
- Защита контента
- Включение операций Notarize
- Истечение срока действия документа
- Просмотр, размещение подписей и добавление полей
- Порядок подписания
- Добавить себя
- Ссылка для загрузки соглашения
- Границы полей форм
- Режим Liquid Mode
- Элементы управления для настраиваемого рабочего процесса
- Возможности для отправки на странице эл. подписания
- URL перенаправления при подтверждении после подписания
- Ограничение доступа к общим соглашениям
- Отображение страницы отправки после входа
- Шаблоны сообщений
- Требования биофармацевтической отрасли
- Интеграция с рабочим процессом
- Настройки нотариального заверения
- Интеграция платежной системы
- Сообщения для подписывающих сторон
- Параметры SAML
- Конфигурация SAML
- Установка Microsoft Active Directory Federation Service
- Установка Okta
- Установка OneLogin
- Установка Oracle Identity Federation
- Конфигурация SAML
- Управление данными
- Настройки меток времени
- Внешний архив
- Языки учетной записи
- Параметры электронной почты
- Переход с домена с echosign.com на adobesign.com
- Настройка параметров для получателей
- Руководство по нормативным требованиям
- Специальные возможности
- Закон об ответственности и переносе данных о страховании здоровья граждан (HIPAA)
- Общий регламент по защите данных (GDPR)
- 21 CFR, часть 11 и приложение EudraLex 11
- Клиенты в области здравоохранения
- Поддержка IVES
- Хранящиеся соглашения
- Рекомендации для ЕС и Великобритании
- Массовая загрузка документов
- Подтверждение домена
- Ссылки на сообщения о нарушениях
- Системные требования и ограничения
Отправка, подписание соглашений и управление ими
- Параметры получателя
- Отмена уведомления по электронной почте
- Параметры на странице эл. подписания
- Параметры на странице эл. подписания
- Открытие для чтения соглашения без полей
- Отказ от подписания соглашения
- Делегирование полномочий по подписанию
- Перезапуск соглашения
- Загрузка PDF-файл соглашения
- Просмотр истории соглашения
- Просмотр сообщений о соглашении
- Преобразование электронной подписи в рукописную
- Преобразование рукописной подписи в электронную
- Навигация по полям формы
- Очистка полей формы
- Увеличение страниц электронного документа и навигация по ним
- Изменение языка, используемого в инструментах соглашения и сведениях о нем
- Просмотр юридической информации
- Настройка параметров файлов cookie Acrobat Sign
- Отправка соглашений
- Страница «Отправка» (Создание)
- Обзор меток и функций
- Селектор групп
- Добавление файлов и шаблонов
- Название документа
- Общее сообщение
- Срок выполнения
- Напоминания
- Защита паролем файлов PDF
- Тип подписи
- Язык для получателя
- Порядок и поток подписания получателями
- Роли получателей
- Аутентификация получателей
- Личное сообщение для получателя
- Доступ получателя к соглашению
- Получатели копий
- Проверка личности
- Отправка соглашения только себе
- Отправка соглашения другим пользователям
- Рукописная подпись
- Порядок подписания получателями
- Пакетная отправка
- Страница «Отправка» (Создание)
- Создание полей в документах
- Среда авторинга внутри приложения
- Автоматическое обнаружение полей
- Перетаскивание полей в среде авторинга
- Назначение полей форм получателям
- Предварительно заполняемая роль
- Применение полей с помощью шаблона для повторного использования
- Перенос полей в новый шаблон библиотеки
- Обновленный интерфейс авторинга при отправке соглашений
- Создание форм и текстовых тегов
- Создание форм с помощью Acrobat (AcroForms)
- Поля
- Типы полей
- Стандартные типы полей
- Поля электронной подписи
- Поле инициалов
- Поле «Имя получателя»
- Поле «Адрес электронной почты получателя»
- Поле «Дата подписания»
- Текстовое поле
- Поле даты
- Числовое поле
- Флажок
- Группа флажков
- Переключатель
- Раскрывающиеся меню
- Наложение ссылок
- Поле платежа
- Вложения
- Штамп участника
- Номер транзакции
- Изображение
- Компания
- Должность
- Штамп
- Внешний вид содержимого поля
- Проверки полей
- Значения маскируемых полей
- Настройка условий отображения/скрытия
- Вычисляемые поля
- Проверенные формы
- Типы полей
- Часто задаваемые вопросы об авторинге
- Среда авторинга внутри приложения
- Подписание соглашений
- Управление соглашениями
- Управление видом страницы
- Скопировать соглашение
- Делегирование соглашений
- Замена получателей
- Ограниченная видимость документа
- Отмена соглашения
- Создание новых напоминаний
- Просмотр напоминаний
- Отмена напоминания
- Доступ к потокам Power Automate
- Другие действия...
- Как работает поиск
- Просмотр соглашения
- Создание шаблона на основе соглашения
- Скрытие/отображение соглашений в представлении
- Добавление подписанного соглашения
- Изменение файлов или полей в отправленном соглашении
- Изменение метода аутентификации получателя
- Добавление или изменение срока действия
- Добавление примечания к соглашению
- Предоставление доступа к отдельному соглашению
- Отмена доступа к соглашению
- Загрузка отдельного соглашения
- Загрузка отдельных файлов соглашения
- Загрузка отчета об аудите для соглашения
- Загрузка содержимого полей для соглашения
- Отчет об аудите
- Отчеты и экспорт данных
- Обзор
- Предоставление пользователям доступа к отчетам
- Диаграммы отчетов
- Экспорт данных
- Переименование отчета или экспорта
- Дублирование отчета или экспорта
- Назначение отчета или экспорта
- Удаление отчета или экспорта
- Проверка использования транзакций
Расширенные возможности и рабочие процессы для работы с соглашениями
- Веб-формы
- Шаблоны для повторного использования (Шаблоны библиотеки)
- Формы государственных учреждений США в библиотеке Acrobat Sign
- Создание шаблона библиотеки
- Изменение имени шаблона библиотеки
- Изменение типа шаблона библиотеки
- Изменение уровня доступа к шаблону библиотеки
- Копирование, редактирование и сохранение общего шаблона
- Загрузка данных для агрегированного поля в шаблоне библиотеки
- Передача прав владения веб-формами и шаблонами библиотек
- Рабочие процессы Power Automate
- Обзор интеграции с Power Automate и включенных в нее прав
- Включение интеграции Power Automate
- Контекстные действия на странице «Управление»
- Отслеживание использования Power Automate
- Создание потока (с примерами)
- Триггеры, используемые для потоков
- Импорт потоков извне Acrobat Sign
- Управление потоками
- Редактирование потоков
- Общий доступ к потокам
- Отключение и включение потоков
- Удаление потоков
- Полезные шаблоны
- Только администратор
- Архивирование соглашений
- Сохранение заполненных документов в SharePoint
- Сохранение заполненных документов в OneDrive для бизнеса
- Сохранение заполненных документов на Google Диске
- Сохранение всех заполненных документов в Dropbox
- Сохранение заполненных документов в Box
- Архивирование соглашений веб-форм
- Сохранение заполненных документов веб-форм в библиотеке SharePoint
- Сохранение всех заполненных документов в OneDrive для бизнеса
- Сохранение заполненных документов на Google Диске
- Сохранение заполненных документов веб-форм в Box
- Извлечение данных соглашения
- Уведомления о соглашениях
- Отправка по электронной почте настраиваемых уведомлений с содержимым соглашения и подписанным соглашением
- Получение уведомлений Adobe Acrobat Sign в канале Teams
- Получение уведомлений Adobe Acrobat Sign в Slack
- Получение уведомлений Adobe Acrobat Sign в Webex
- Создание соглашения
- Создание документа на основе формы Power Apps и шаблона Word, отправка на подпись
- Создание соглашения на основе шаблона Word в OneDrive и получение подписи
- Создание соглашения по выбранной строке Excel, отправка на проверку и подпись
- Настраиваемые рабочие процессы отправки
- Предоставление доступа к пользователям и соглашениям
Интеграция с другими продуктами
- Обзор интеграции с Acrobat Sign
- Acrobat Sign для Salesforce
- Acrobat Sign для Microsoft
- Другие интеграции
- Интеграции, управляемые партнерами
- Как получить ключ интеграции?
Разработчик Acrobat Sign
- Интерфейсы REST API
- Веб-перехватчики
- Адрес
Поддержка и устранение неполадок
Доступ к API предусмотрен исключительно для учетных записей уровня организации и разработчика.
Ссылки на основную документацию
Полезные ссылки для REST API 6:
- Регистрация учетной записи разработчика: https://www.adobe.com/acrobat/business/developer-form.html
- Методы в приложении: https://secure.adobesign.com/public/docs/restapi/v6
- Примеры: https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/samples
- Веб-перехватчики: https://developer.adobe.com/acrobat-sign/docs/overview/acrobat_sign_events
Поддержка устаревших SOAP API прекращена в мае 2021 г.
Все клиенты, использующие SOAP API, должны как можно скорее перейти на REST API.
После входа в систему выберите Acrobat Sign API > Сведения об API > Rest API и документация.
Общие понятия
Вы не можете написать документ, просмотрев страницу в веб-интерфейсе или перетащив его, или назначить роли подписывающей стороны с помощью идентификатора transientDocumentId в API.
Вызов промежуточных документов возвращает идентификатор transientDocumentID, действительный в течение 7 дней. Его можно использовать только для дальнейших вызовов API. Он хранится на сервере API и получает этот идентификатор. Загрузите файл и указывайте его идентификатор в последующих вызовах API.
Вы не можете напрямую загрузить документ в Соглашение с помощью REST API.
В соответствии с требованиями REST сначала создайте промежуточный документ, а затем используйте этот идентификатор в качестве источника файла в методах «Соглашение», «Виджет» или «Библиотека».
Промежуточный документ является исходным файлом, таким как PDF, doc, docx, загруженным на серверы Adobe. Это удобный способ передачи базового документа на серверы API и промежуточный документ в Интернете.
Да, соглашения можно публиковать с помощью рабочих процессов в версии 6 с помощью вызова API POST /agreements. Передайте параметр идентификатора рабочего процесса в вызове API.
Идентификатор рабочего процесса можно получить с помощью вызова GET /workflows.
-
-
Перейдите в Acrobat Sign API > Журнал запросов API.
-
Выполните вход в Acrobat Sign как администратор.
-
Перейдите в: Acrobat Sign API > Сведения об API
-
Нажмите ссылку Образцы REST API.
Примечание.Чтобы загрузить пакет SDK JavaScript, см. https://github.com/adobe-sign/AdobeSignJsSdk.
Начиная с версии 6, параметр sendTroughWeb больше не доступен. Вместо него предусмотрено state. Это состояние, в котором пребывает документ. Поле состояния можно указать только при выполнении вызовов POST. Оно не возвращается в GET /agreements/{ID} и игнорируется, если указано в вызове PUT /agreements/{ID}. Окончательный статус соглашения можно получить из GET /agreements/ID.
state(строка) = ['AUTHORING' или 'DRAFT' или 'IN_PROCESS'].
AUTHORING позволяет пользователю создавать документы соглашения перед их отправкой. Операция авторинга означает создание, редактирование или размещение полей формы вместе с их конфигурациями (назначенное лицо, условия, тип данных и т. д.) в документах соглашения. После публикации документа в состоянии «Авторинг» документ отображается в разделе «Черновик» на вкладке «Управление» Acrobat Sign.
DRAFT — это временный или начальный этап окончательного целевого ресурса, который можно обновить пошагово для создания окончательного ресурса, и не отображаемый в разделе «Черновик» на вкладке «Управление» Acrobat Sign. При использовании состояния «Черновик» информация о наборе участника не требуется, и ее можно назначить позже при создании PUT /agreements/agreementId для завершения этого черновика. Этот шаг можно повторять несколько раз, пока не будут получены все необходимые данные для создания соглашения.
IN_PROCESS изменяет статус соглашения на «Отправлено на подпись» и отображается в разделе «Отправлено на подпись» на вкладке «Управление» Acrobat Sign.
sendThroughWeb позволяет отправлять соглашение в интерактивном режиме. Различные параметры в поле «options» в запросе POST /agreements версии 5 позволяют пользователю настроить это интерактивное представление (страницу Отправка). Все эти параметры конфигурации страницы, такие как fileUploadOptions, перемещаются в API POST agreements/ID/views.
Таким образом, вы можете выполнить sendThroughWeb, создав соглашение в состоянии AUTHORING с помощью API-интерфейса POST /agreements. Затем, чтобы запросить URL-адрес следующей страницы в нужной конфигурации, выполните вызов API POST agreements/ID/views.
Выполните следующие действия:
1. Перейдите к документацию REST API версии 6 и выберите метод POST/agreements.
2. Используйте следующий код запроса:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
3. Теперь используйте метод post /agreements/{agreementId}/views со следующим кодом запроса:
{ "name": "AUTHORING" } |
Код ответа содержит URL-адрес для полей авторинга.
URL-адрес обратного вызова можно определить следующими способами:
- Используйте следующий параметр для определения URL-адреса обратного вызова по мере необходимости:
"callbackInfo": "",
- Обратитесь в службу поддержки Acrobat Sign, чтобы установить URL-адрес обратного вызова по умолчанию для всей учетной записи.
Интерфейс SOAP (SmartBear) отображает ошибку подключения SSL, аналогичную той, что появляется при вызове API и указана далее. Эта ошибка обычно возникает, если используется устаревший протокол SSL или протокол TLS ниже TLS1.2.
ERROR: Exception in request: javax.net.ssl.SSLException: Received fatal alert: protocol_version
ERROR: An error occurred [Received fatal alert: protocol_version], see error log for details
-
Добавьте (-Dsoapui.https.protocols=SSLv3,TLSv1.2) в файл VMOPTIONS в папке Bin.
-
Перейдите в папку C:\Program Files\SmartBear\SoapUI-5.2.1\bin (зависит от того, где установлен интерфейс SOAP). Он может находиться в папке C:\Program Files (x86)).
-
В файле VMOPTIONS включите полное разрешение на чтение/запись файла.
-
Нажмите правой кнопкой мыши на файл VMOPTIONS > «Свойства» > вкладка «Безопасность» > «Выбрать пользователя» > нажмите «Редактировать». (На кнопке «Редактировать» появится значок управления доступом пользователя) > установите все флажки и нажмите «OK».
-
Повторите эти действия для администраторов, систем и всех пакетов приложений.
-
Откройте файл с помощью «Блокнота».
-
Добавьте этот протокол внизу «-Dsoapui.https.protocols=SSLv3,TLSv1.2» и сохраните изменения.
-
Закройте интерфейс SOAP и перезапустите. При выполнении вызова API он работает без ошибок SSL. (Для проверки выполните тестовый ping-вызов).
Ниже приведены действия по созданию идентификатора клиента и секретного ключа клиента в приложении Acrobat Sign.
-
Войдите в Acrobat Sign как администратор.
-
Перейдите в Acrobat Sign API > Приложения API.
-
Чтобы создать приложение, выберите значок плюса ( + ).
-
Введите Имя и отображаемое имя.
-
В разделе Домен выберите CUSTOMER.
Сохраните настройку.
-
Выберите приложение, чтобы просмотреть доступные для пользователя действия.
-
Выберите Настройка параметров OAuth для приложения.
-
Введите URI перенаправления.
-
Установите флажки для каждой области, которую необходимо включить, и определите, ограничена ли область пользователем (self), группой или учетной записью.
-
Сохраните настройку.
-
Войдите в Acrobat Sign как администратор учетной записи.
-
Перейдите в: Acrobat Sign API > Сведения об API
-
Откройте ссылку Ключ интеграции.
Примечание.Если вы не видите ссылку «Ключ интеграции», обратитесь в службу поддержки, чтобы включить учетную запись.
-
- Назовите ключ интуитивно понятным значением.
- Выберите различные Области, необходимые для работы приложения.
- После настройки параметров ключа нажмите Сохранить.
-
После сохранения ключ находится в: Личные настройки > Маркеры доступа.
Отображаются имя ключа и список всех включенных областей.
Нажмите описание ключа один раз, чтобы отобразить ссылки на действия:
- Ключ интеграции — эта ссылка предоставляет буквенный ключ.
- Отозвать — выполняет отзыв и удаление маркера доступа без возможности восстановления.
-
Войдите в Acrobat Sign как администратор.
-
Перейдите в Acrobat Sign API > Приложения API.
-
Выберите ваше приложение, чтобы открыть доступные действия.
-
Выберите Настройка параметров OAuth для приложения.
-
Сгенерируйте код авторизации, используя следующую ссылку. Идентификатор клиента, URI перенаправления и области должны совпадать со следующим URL-адресом, выбранным в приложении (не ставьте пробел в followingURL, и сегмент типа «NA1» соответствует принадлежности учетной записи Acrobat Sign):
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account -
Если вызов выполнен успешно, выберите код авторизации в адресной строке.
-
Загрузите и установите Postman по ссылке https://www.getpostman.com/apps.
-
После загрузки и установки выберите NEW для создания POST.
-
Введите ссылку https://secure.na1.adobesign.com/oauth/token в соответствии с принадлежностью вашей учетной записи Acrobat Sign.
-
В разделе Headers введите Content-Type как application/x-www-form-urlencoded.
-
Убедитесь, что в разделе Body выбрано x-www-form-urlencoded, введите следующие параметры с соответствующими значениями из приложения, созданного в учетной записи Acrobat Sign, и нажмите SEND.
-
Если вся информация верна, в ответе возвращается маркер доступа и маркер обновления:
При выполнении процесса OAuth необходимо выполнить следующие действия:
1. Указать правильный идентификатор клиента и URI перенаправления.
2. Учитывать, что области, указанные в URL-адресе авторизации, должны точно совпадать с областями, указанными в приложении Acrobat Sign.
3. Использовать правильный сегмент (na1, na2, au1, eu1, jp1) в соответствии с настройкой учетной записи.
4. Удалить все пробелы, указанные в URL-адресе авторизации (при наличии).
5. Проверить синтаксис URL-адреса авторизации.
https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send
Маркеры доступа действительны только в течение 3600 секунд (одного часа), после чего их срок действия истекает.
Владелец запроса API может использовать маркеры обновления для создания новых маркеров доступа по мере необходимости.
Веб-перехватчики поддерживаются в REST API версии 6 и выше.
Если получатель веб-перехватчика не отвечает в течение 72 часов, веб-перехватчик отключается и уведомление не отправляется.
Если целевой URL-адрес веб-перехватчика по какой-либо причине отключен, Acrobat Sign создает очередь JSON и повторяет попытку загрузки в нарастающем цикле в течение 72 часов.
Не доставленные события сохраняются в очереди повторных попыток, и в течение следующих 72 часов предпринимаются все усилия для доставки уведомлений в том порядке, в котором они возникали.
Стратегия повторной доставки уведомлений заключается в удвоении времени между попытками, начиная с 1-минутного интервала, увеличивающегося до 12 часов, что обеспечивает 15 попыток за 72 часа.
Чтобы создать веб-перехватчик непосредственно в интерфейсе пользователя Acrobat Sign, сначала создайте URL-адрес веб-перехватчика с помощью приложений-функций Azure AD, выполнив следующие действия:
-
Войдите в систему с помощью учетной записи Microsoft https://portal.azure.com/.
-
Зарегистрируйтесь в разделе «Приложения-функции» в учетной записи AzureAD.
-
Перейдите в AzureAD и выберите Приложения-функции > нажмите значок + для доступа к функциям.
-
Выберите «Webhook+API» с Javascript в качестве языка и нажмите «Создать функцию».
-
Замените файл Index.js фрагментом кода:
module.exports = function (context, req) { var clientId = req.headers['x-adobesign-clientid']; // Validate that the incoming ClientID is genuine if (clientId === '************************************') { context.res = { // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable body: { 'xAdobeSignClientId' : clientId, }, headers : { 'Content-Type' : 'application/json' } }; } else { context.res = { status: 400, body: "Opps!! Illegitimate Call identified" }; } context.done(); }; -
Нажмите кнопку «Тестировать» в правом углу и укажите следующий заголовок:
X-AdobeSign-ClientId как ***********************
-
Выберите «Сохранить и запустить».
-
После получения 200 ответов OK со следующим заголовком нажмите «Получить URL-адрес функции».
-
Скопируйте URL-адрес и перейдите в пользовательский интерфейс Acrobat Sign > «Веб-перехватчики» > нажмите значок «+», чтобы создать.
-
Введите следующие данные:
- Имя: желательно интуитивно понятное имя, которое могут легко понять другие администраторы.
- Область: диапазон сети, в которой действует веб-перехватчик. В интерфейсе доступны «Учетная запись» и «Группа».
API поддерживает области «Учетная запись», «Группа», «Пользователь» и «Ресурс». - Для веб-перехватчика можно определить только одну область.
- URL-адрес: целевой URL-адрес, на который приложение Acrobat Sign передало полезные данные JSON.
- События: факторы, вызывающие создание JSON в Acrobat Sign и его передачу на URL-адрес.
Каждое событие создает различные полезные данные, связанные с событием-триггером
. В один веб-перехватчик можно включить несколько событий. - Параметры уведомления: параметры уведомления определяют разделы полезных данных JSON события, позволяющие выбрать только важные разделы события.
-
Полностью определив веб-перехватчик, нажмите «Сохранить», и новый веб-перехватчик немедленно начнет реагировать на события.
Ресурс соглашения относится к ресурсу, с помощью которого можно создать соглашение, например документ библиотеки, виджет и само соглашение.
Чтобы найти события ресурсов соглашения, сначала отправьте запрос к API, который создает agreementAssetEvents с соответствующими параметрами поиска.
Ответ — это первая страница результатов вместе с параметром идентификатора поиска и курсором следующей страницы. Его можно использовать для получения результатов на следующих страницах, если они доступны, с помощью API, который извлекает agreementAssetEvents на основе идентификатора поиска.
-
Откройте документацию по REST API для версии 5.
-
Перейдите к post/search/agreementAssetEvents и создайте маркер доступа с соответствующей областью.
-
В коде запроса укажите дату начала и окончания в соответствии с требованиями:
{ "endDate": "2018-05-22T22:33:33", "startDate": "2017-12-22T22:33:33" } -
Нажмите кнопку Try it out. Это извлечет идентификаторы ресурсов соглашения, которые также можно использовать в качестве идентификаторов соглашения.
Управление пользователями/учетными записями
- Выполните вход в Acrobat Sign.
- Перейдите в Acrobat Sign API > документация REST API.
- Выберите версию 5.
- В методе post /users используйте код запроса, указанный для метода
UserCreationInfo
{
"email": "email@email.com",
"firstName": "AA",
"lastName": "AB",
"password":"12******rte"
}
Учетные записи Acrobat Sign, использующие Admin Console (Adobe One) для управления правами пользователей, не могут использовать Acrobat Sign API для создания пользователей или управления существующими пользователями.
Adobe One Admin Console использует другой API, а не Acrobat Sign API. Дополнительные сведения см. в следующих статьях:
Получение идентификатора группы:
-
Перейдите по ссылке https://secure.na1.echosign.com/public/docs/restapi/v5.
-
В разделе «Resources and Operations» выберите группы.
-
Нажмите GET /groups.
-
Нажмите кнопку «OAuth Access-token».
-
Создайте маркер доступа.
-
Нажмите кнопку Try it out.
Вы получите следующий ответ с именем группы и идентификатором группы:
{ "groupInfoList": [ { "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", "groupName": "Default Group" }, { "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", "groupName": "test" }, ] }
Удаление группы:
-
Нажмите DELETE /groups/{groupId}.
-
Чтобы создать маркер доступа, нажмите кнопку OAuth Access-token.
-
Добавьте идентификатор удаляемой группы, полученный в ответ на предыдущий вызов, в поле groupId.
-
Нажмите Try it out.
После удаления группы вы получите ответ: No content.
Невозможно удалить группу, в которую назначен пользователь. По сути, можно удалить только пустую группу. Если в группе есть пользователь, вы получите следующий ответ.
"code": "GROUP_NOT_EMPTY", "message": "Эту группу нельзя удалить — она не пустая." } |
Инициирование/отправка документов
Создание промежуточного документа
-
Перейдите по адресу: https://secure.na1.adobesign.com/public/docs/restapi/v6.
-
Нажмите transientDocuments (Промежуточные документы) и разверните метод POST /transientDocuments.
-
Нажмите кнопку OAuth Access-token.
-
- Включите Scopes для транзакции.
- Нажмите Authorize.
-
Если требуется, нажмите Allow Access.
-
Вы вернетесь на страницу методов API. Значение авторизации будет уже указано.
- Введите имя файла в поле File-Name.
- Нажмите кнопку Choose File и добавьте документ для соглашения.
- Нажмите Try it out.
-
Будет создан ответ.
Идентификатор transientDocumentID можно найти в теле ответа:
Создание документа с помощью промежуточного документа
-
Перейдите по адресу: https://secure.na1.adobesign.com/public/docs/restapi/v6.
-
Нажмите agreements и разверните метод POST /agreements.
-
- Нажмите кнопку OAuth Access-token.
- Включите область OAuth.
- Нажмите Authorize.
- Если требуется, нажмите Allow Access.
-
Вы вернетесь на страницу методов API. Значение авторизации будет уже указано.
- Скопируйте приведенный ниже сценарий в текстовый редактор (этот сценарий является лишь примером минимальной конфигурации; ваш окончательный код будет другим).
- Вставьте значение идентификатора промежуточного документа в код, как указано:
{ "fileInfos": [ {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} ], "name": "test doc", "participantSetsInfo": [ { "memberInfos": [ { "email": "noreply@echosign.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "DRAFT" }- Скопируйте свой собственный сценарий и вставьте его в поле AgreementInfo.
- Нажмите Try it out.
-
Будет создан ответ.
Значение agreementID можно найти в Теле ответа:
Ниже приведены действия по добавлению файлов в параметр FileInfo.
-
Используйте идентификатор промежуточного документа:
Перейдите к POST/transientDocuments и добавьте из локальной системы документ для использования.
Используйте идентификатор промежуточного документа, сгенерированный в разделе «Сведения о файле» в POST/Agreements:"fileInfos": [ { "transientDocumentId": "" } ], -
Используйте идентификатор библиотечного документа:
Перейдите на панель управления. Нажмите «Добавить документ в библиотеку» и сохраните шаблон.
В разделе «Документация по REST API» нажмите GET /libraryDocuments и извлеките идентификатор библиотеки для создаваемого шаблона.
В разделе POST/Agreements укажите идентификатор библиотечного документа:"libraryDocumentId": "", "libraryDocumentName": "",
-
Используйте общедоступный URL-адрес:
Укажите общедоступный URL-адрес для использования в параметре FileInfo:
{ "documentURL": { "mimeType": "", "name": "", "url": "" },
-
Перейдите на веб-сайт https://secure.na1.adobesign.com/public/docs/restapi/v6.
-
Выберите вариант Agreements> POST/agreements.
-
Выберите параметр Oauth Access-Token и укажите необходимые области.
-
После добавления маркера доступа можно использовать следующий код запроса:
{ "documentCreationInfo": { "recipientSetInfos": [ { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{"email": "testemail@email.com"}] } ], "signatureFlow": "SEQUENTIAL", "name": "husband wife", "signatureType": "ESIGN", "fileInfos": [ { "transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} ] } }
В ходе вызова POST /agreements для параметра signatureflow можно передать значение SENDER_SIGNS_FIRST или SENDER_SIGNS_LAST, чтобы добавить отправителя как первую или последнюю подписывающую сторону, соответственно.
Это пример вызова в формате JSON:
{
"documentCreationInfo": {
"fileInfos": [
{ "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"
}
],
"name": "Test",
"recipientSetInfos": [
{
"recipientSetMemberInfos": [
{
"email": "test@email.com"
}
],
"recipientSetRole": "SIGNER"
}
],
"signatureType": "ESIGN",
"signatureFlow": "SENDER_SIGNS_FIRST"
}
}
Параметр отправки от имени доступен только в REST API версии 6 со включенным расширенным общим доступом.
Если разрешение на отправку не предоставлено в рамках общего доступа или если Расширенный общий доступ не включен, вы получите примерно следующий ответ:
{"code":"PERMISSION_DENIED","message":"У пользователя, указанного в заголовке x-on-behalf-of-user , нет разрешения, необходимого для выполнения этой операции."}
|
Для функции «Отправка от имени» включите «Расширенный общий доступ к учетной записи», чтобы пользователи могли предоставлять разрешения на отправку другим пользователям при совместном использовании учетной записи. Подробнее о расширенном общем доступе к учетной записи см. Включение расширенного общего доступа к учетной записи.
После включения общего доступа для пользователей выполните следующие действия, чтобы отправить от имени пользователя:
Создайте промежуточный документ:
-
Перейдите на веб-сайт https://secure.adobesign.com/public/docs/restapi/v6.
-
В разделе transientDocuments нажмите POST /transientDocuments.
-
Чтобы создать маркер для авторизации, нажмите кнопку OAUTH ACCESS-TOKEN.
-
В x-on-behalf-of-user укажите адрес электронной почты пользователя, от имени которого вы хотите отправить документ, в следующем формате: email:test@email.com.
-
Чтобы выбрать файл, нажмите Choose File, а затем нажмите Try it out.
Вы получаете ответ примерно следующего вида со значением transientDocumentId:
{"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}
Создание соглашения с помощью промежуточного документа:
-
В разделе agreements, нажмите POST /agreements.
-
Чтобы создать маркер для авторизации, нажмите кнопку OAUTH ACCESS-TOKEN.
-
В x-on-behalf-of-user укажите адрес электронной почты пользователя, как это было сделано при создании промежуточного документа.
-
В поле AgreementInfo добавьте следующий код и нажмите кнопку Try it out.
{ "fileInfos": [ { "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" } ], "name": "Test", "participantSetsInfo": [ { "memberInfos": [ { "email": "signer@email.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "IN_PROCESS" }Вы получите ответ примерно следующего вида со значением agreementId:
{ "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" }
-
Выполните вход в Acrobat Sign.
-
Перейдите в Acrobat Sign API > Сведения об API и нажмите «Документация по методу REST API».
-
Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.
-
Скопируйте идентификатор промежуточного документа и используйте его в методе POST /agreements. Укажите в поле следующий запрос JSON:
{ "documentCreationInfo": { "mergeFieldInfo": null, "recipientSetInfos": [{ "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "test1@gmail.com" }], "privateMessage": "Hello 1", "securityOptions": null }, { "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "test2@gmail.com" }], "privateMessage": "Hello 2", "securityOptions": null } ], "signatureType": "ESIGN", "callbackInfo": null, "message": "Please review and sign this document.", "locale": "en_US", "vaultingInfo": null, "securityOptions": null, "reminderFrequency": null, "ccs": null, "postSignOptions": null, "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "daysUntilSigningDeadline": null, "formFieldLayerTemplates": [], "name": "Acrobat Sign Agreement", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "XXXXXXXXXXXX", "documentURL": null, "libraryDocumentId": null }] } } -
Чтобы выполнить запрос JSON, нажмите кнопку Try it out.
Правильный JSON возвращает ответ с идентификатором соглашения.
Ниже перечислены параметры, которые можно передать в код, чтобы установить открытый пароль:
{ "documentCreationInfo": [{ "signatureType": "ESIGN", "recipientSetInfos": [{ "recipientSetMemberInfos": [{ "email": "abc@xyz.com" }],
"recipientSetRole": "SIGNER" }], "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "fileInfos": [ { "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V" } ], "name": "Open password to view document", "securityOptions": { "openPassword": "1234", "protectOpen": true } }] }
|
Чтобы создать соглашение с помощью API с состоянием «AUTHORING», выполните следующие действия.
Перейдите к Post /agreements и создайте маркер доступа с необходимыми областями.
Используйте следующий код запроса:
{ "fileInfos": [ { "transientDocumentId": "*********************" } ], "name": "A1", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@xyz.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" }
|
В версии 6 предусмотрен набор API авторинга для создания соглашения. В версии 5 поля форм используются непосредственно в POST /agreements api. Однако в версии 6 пользователь может создать соглашение в состоянии АВТОРИНГА (state = AUTHORING) с помощью POST /agreements версии 6 и использовать PUT /agreements/ID/formFields позже для добавления полей формы в документы этого соглашения.
Необходимые шаги указаны далее.
-
Перейдите к документации REST API версии 6 и выберите метод POST/agreements.
-
Используйте следующий код запроса:
{ "fileInfos": [ { "transientDocumentId": "***************************" } ], "name": "test", "participantSetsInfo": [ { "memberInfos": [ { "email": "abc@gmail.com" } ], "order": 1, "role": "SIGNER" } ], "signatureType": "ESIGN", "state": "AUTHORING" } -
Используйте метод put /agreements/{agreementId}/formFields со следующим запросом в качестве примера:
{ "fields": [ { "locations": [ { "height": 36, "left": 75, "pageNumber": "1", "top": 200, "width": 150 } ], "contentType": "SIGNATURE_BLOCK", "name": "sigBlock1", "inputType": "SIGNATURE", "recipientIndex":1 } ]}После завершения запроса соглашение будет отправлено указанному получателю.
-
Выполните вход в Acrobat Sign.
-
Перейдите в «Acrobat Sign API» > «Сведения об API» и нажмите «Документация по методу REST API».
-
Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.
-
Скопируйте идентификатор промежуточного документа и используйте его в методе POST /agreements. Укажите в поле следующий запрос JSON:
{ "documentCreationInfo": { "recipientSetInfos": [{ "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test1@gmail.com" }], "privateMessage": "Hello 1" }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test2@gmail.com" }], "privateMessage": "Hello 2" } ], "signatureType": "ESIGN", "message": "Please review and sign this document.", "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "name": "Demo1", "fileInfos": [{ "transientDocumentId": "XXXXXXXXXX" }], "formFields": [{ "hidden": "1", "defaultValue": "test1@gmail.com", "name": "Signer Email (Applicant-1)", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 1, "top": 100, "left": 100, "width": 100, "height": 30 }, "contentType": "SIGNER_EMAIL" }, { "name": "Signature (Applicant-2)", "inputType": "SIGNATURE", "locations": { "pageNumber": 1, "top": 520, "left": 162, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-3)", "inputType": "SIGNATURE", "locations": { "pageNumber": 2, "top": 312, "left": 154, "width": 280, "height": 30 }, "contentType": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "defaultValue": "017/09/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-4)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 2, "top": 260, "left": 90, "width": 80, "height": 30 }, "contentType": "DATA", "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-5)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 199, "left": 179, "width": 276, "height": 30 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 1 }, { "contentType": "SIGNATURE_DATE", "defaultValue": "06/07/2018", "displayFormatType": "DATE", "name": "Signature Date (Applicant-6)", "format": "DATE_DD_MM_YYYY", "inputType": "TEXT_FIELD", "readOnly": true, "locations": { "pageNumber": 3, "top": 188, "left": 488, "width": 76, "height": 25 }, "required": 1, "recipientIndex": 1 }, { "name": "Signature (Applicant-7)", "inputType": "SIGNATURE", "locations": { "pageNumber": 3, "top": 370, "left": 37, "width": 210, "height": 26 }, "contentType ": "SIGNATURE", "required": 1, "recipientIndex": 2 }, { "contentType ": "SIGNATURE_DATE", "defaultValue": "01/02/2018", "name": "Signature Date (Applicant-8)", "locations": { "pageNumber": 3, "top": 370, "left": 300, "width": 76, "height": 26 }, "required": 1, "recipientIndex": 2 } ] } } -
Чтобы выполнить запрос JSON, нажмите кнопку Try it out.
Правильный JSON возвращает ответ с идентификатором соглашения.
-
Выполните вход в Acrobat Sign.
-
Перейдите в «Acrobat Sign API» > «Сведения об API» и нажмите «Документация по методу REST API».
-
Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.
-
Скопируйте идентификатор промежуточного документа и используйте его в методе POST /agreements. Укажите в поле следующий запрос JSON:
{ "options": { "noChrome": true, "authoringRequested": true }, "documentCreationInfo": { "recipientSetInfos": [{ "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test1@gmail.com" }], "privateMessage": "Hello 1" }, { "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "email": "test2@gmail.com" }], "privateMessage": "Hello 44" } ], "signatureType": "ESIGN", "message": "Please review and sign this document.", "locale": "en_US", "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "formFieldLayerTemplates": [], "name": "Acrobat Sign Agreement", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "XXXXXXXXXXXX" }] } } -
Чтобы выполнить запрос JSON, нажмите кнопку Try it out.
Правильный JSON возвращает ответ с идентификатором соглашения.
-
Чтобы открыть соглашение в режиме авторинга, скопируйте URL-адрес и вставьте его в адресную строку браузера.
-
Перетащите поля формы в нужное место.
-
Чтобы отправить соглашение на подпись, нажмите «Отправка».
Используйте POST /agreements для создания соглашения. Отправляет его на подпись и возвращает значение agreementID в ответ клиенту. Ниже приведен формат JSON для отправки соглашения с использованием метода аутентификации по телефону.
{ "documentCreationInfo": { "mergeFieldInfo": null, "recipientSetInfos": [{ "signingOrder": null, "recipientSetRole": "SIGNER", "recipientSetMemberInfos": [{ "securityOptions": null, "email": "Signer@email.com" }],
"privateMessage": null, "securityOptions": [{ "authenticationMethod": "PHONE", "phoneInfos": [{ "phone": "1111111111", "countryCode": "+1" }] }] }],
"signatureType": "ESIGN", "callbackInfo": null, "message": "Please review and sign this document.", "locale": "en_US", "vaultingInfo": null, "securityOptions": null, "reminderFrequency": null, "ccs": null, "postSignOptions": null, "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "daysUntilSigningDeadline": null, "formFieldLayerTemplates": [], "name": "Acrobat Sign Agreement-Phone authentication testing", "formFields": null, "fileInfos": [{ "libraryDocumentName": null, "transientDocumentId": "3AAABLYourTransactionID", "documentURL": null, "libraryDocumentId": null }] },
"options": { "autoLoginUser": true, "authoringRequested": false, "noChrome": true, "sendThroughWeb": null, "sendThroughWebOptions": null, "locale": "en_US" } }
|
Данные можно объединить непосредственно в поля формы следующими способами:
- С помощью шаблона библиотеки:
при использовании идентификатора шаблона библиотеки в параметре FileInfo обязательно укажите точное имя поля и относящиеся к нему данные в следующем разделе:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
- С помощью текстовых тегов в документе, загруженном как промежуточный:
при загрузке документа, содержащего текстовые теги, добавленные в него как в промежуточный, обязательно укажите точное имя поля и относящиеся к нему данные в следующем разделе:
"mergeFieldInfo": [ { "defaultValue": "", "fieldName": "" } ],
|
Как отправить соглашение с помощью API с предварительно заполненными значениями для определенных полей формы (mergefield)?
Для выполнения этого вызова необходимо сначала выполнить шаг «Добавление промежуточного документа» и получить значение «transientDocumentId» (с помощью secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) для использования в этом шаге.
- Этот вызов включает раздел «mergeFieldInfo», в котором указаны значения по умолчанию для определенных полей формы.
- Это позволяет предварительно вносить данные из другой системы в вызове API.
- Эти поля в соглашении доступны для редактирования или только для чтения.
Предварительные условия:
- Идентификатор промежуточного документа
- Имена полей и их значения
Пример вызова запроса:
Запрос: POST /api/rest/v5/agreements HTTP/1.1 Host: api.na1.echosign.com (или можно указать имя своего сегмента, которое можно узнать с помощью вызова getbaseURis: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris Access-Token: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM* x-user-email: sender@yourdomain.com Content-Type: application/json Cache-Control: no-cache
{ "documentCreationInfo": { "signatureType": "ESIGN", "recipientSetInfos": [ { "recipientSetMemberInfos": [ { "email": “signerEmail@domain.com" } ], "recipientSetRole": "SIGNER" } ],
"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", "message": "Please Sign this from us!", "fileInfos": [ { "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT" } ], "name": "MSA Edited”, "mergeFieldInfo": [ { "fieldName": "AccountName", "defaultValue": "Sam's Garage" }, { "fieldName": "AccountNumber", "defaultValue": "8756999" }, { "fieldName": "Zip", "defaultValue": "94501" }, { "fieldName": "City", "defaultValue": "CityVille" }, { "fieldName": "State", "defaultValue": "CA" }, { "fieldName": "Street", "defaultValue": "123 Some Road" }, { "fieldName": "Title1", "defaultValue": "COO" }, { "fieldName": "Description", "defaultValue": "Some new description here" } ] }
}
Ответом на этот вызов будет значение «agreementId», которое необходимо сохранить в системе для последующих вызовов (signingUrl, status, formData и т.д.)
Ответ: { "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ" }
|
При запуске метода «post /megaSigns/{megaSignId}/views» отображается ошибка «Запрошенный просмотр ресурса в текущем состоянии недоступен».
Ошибка отображается, если указанное значение параметра имени является недопустимым в следующем коде запроса:
{
"name": " "
}
Например, если соглашение MegaSign уже в состоянии IN_PROCESS, то, если указано значение AUTHORING, отображается упомянутая ошибка. Убедитесь, что указанное значение соответствует текущему состоянию соглашения.
При выполнении метода «put /megaSigns/{megaSignId}/state» отображается ошибка «Для информации об отмене MegaSign не указано значение».
Ошибка возникает, когда в коде запроса отсутствует параметр
"megaSignCancellationInfo": {
"comment": "",
"notifyOthers": false
}
Вместо использования параметра «Minimal Schema» нажмите «Complete Model Schema» и введите полный код запроса для выполнения вызова API.
Чтобы изменить состояние соглашения MegaSign, используйте put /megaSigns/{megaSignId}/state и выполните следующие действия:
- Перейдите в документацию по REST API версии 6 и выберите метод
put /megaSigns/{megaSignId}/state. - Укажите значение авторизации, а также If-Match и значение megasignID.
- Для получения megasignID используйте get /megaSigns.
- Для получения If-Match используйте get /megaSigns/{megaSignId} и под заголовком найдите «Etag».
- {
"state": "CANCELED",
"megaSignCancellationInfo": {
"comment": "cancel",
"notifyOthers": false
}
}
Для успешной регистрации веб-перехватчика его URL-адрес отвечает на этот запрос на проверку, используя код ответа 2XX, а также может отправить одно и то же значение идентификатора клиента одним из следующих двух способов:
- В заголовке ответа X-AdobeSign-ClientId. Это тот же заголовок, который передается в запросе, и который снова отражается в ответе.
- В теле ответа JSON с ключом X-AdobeSign-ClientId, значением которого является тот же идентификатор клиента, который отправляется в запросе.
Acrobat Sign получает ответ 2xx со значением X-AdobeSign-ClientId. Пользователь может проверить, правильно ли оно настроено в веб-перехватчике.
URL-адрес веб-перехватчика не отвечает, как ожидается. Для каждого уведомления Post, отправленного Acrobat Sign, URL-адрес в ответ отправляет код статуса 2XX и тот же идентификатор клиента, отправленный в заголовках запросов (X-AdobeSign-ClientId), в заголовках ответов.
Полную информацию можно найти по следующей ссылке:
https://developer.adobe.com/acrobat-sign/docs/overview/developer_guide/#!adobedocs/adobe-sign/master/webhooks/webhook_events.md
Если URL-адрес не соответствует данному протоколу, Acrobat Sign интерпретирует это как то, что он не подтвердил запрос и не попытался перенести его в соответствии с надежной политикой.
Если веб-перехватчик не отвечает, и превышено максимальное время повтора или максимальный интервал повтора, веб-перехватчик отключается.
Публикации Twitter™ и Facebook не подпадают под условия Creative Co.
Управление/получение информации о соглашениях
Чтобы изменить документ, который уже отправлен на подпись, используйте метод PUT /agreements/{agreementId}, который позволяет обновить существующее соглашение. Укажите идентификатор промежуточного документа вместе с идентификатором соглашения в следующем коде запроса:
{ "documentUpdateInfo": { "fileInfos": [ { "agreementDocumentId": "", "transientDocumentId": "" } ] } }
|
Ниже приведены инструкции по обновлению состояния с «AUTHORING» на «IN_PROCESS» с помощью Put /agreements/{agreementId}/state.
-
Получите идентификатор соглашения с помощью метода POST/Agreement.
-
Используйте Get /agreements/{agreementId}, чтобы получить актуальный ETag.
-
Перейдите к Put /agreements/{agreementId}/state и укажите следующую информацию: "state": "IN_PROCESS".
Нет.
В нынешнем REST API нет метода для загрузки подписанной копии.
Отправитель должен загрузить подписанную копию со страницы Управление.
DELETE /agreements/ID раньше позволял скрывать соглашение со страницы управления
.
В Adobe появился новый API PUT /agreements/ID/me/visibility для управления отображением соглашения (в GET /agreements). В дополнение к функциям, которые обеспечивает DELETE /agreements/ID, новая конечная точка отображения также позволяет пользователю отменить операцию скрытия, то есть снова сделать соглашение видимым.
Другие возможные действия подробно описаны далее.
- Перейдите к методу get /agreements и получите идентификатор соглашения.
- Нажмите put /agreements/{agreementId}/me/visibility и укажите следующий запрос в качестве примера:
{
"visibility": "HIDE"
}
. Идентификатор соглашения скрыт только из get /libraryDocuments, однако он все еще отображается в пользовательском интерфейсе вкладки «Управление».
По умолчанию функция хранения в API не включена.
Чтобы включить операцию DELETE/agreements , обратитесь к своему менеджеру по работе с клиентами с запросом на включение функции хранения в API для учетной записи.
Для получения дополнительной информации о включении функций хранения для вашей учетной записи см. Acrobat Sign — хранение документов.
-
Войдите в Acrobat Sign как администратор и перейдите по следующей ссылке: https://secure.adobesign.com/public/docs/restapi/v6.
-
- Нажмите agreeements и разверните GET /agreements.
- Нажмите кнопку OAUTH ACCESS-TOKEN.
- Включите область agreement_read:self.
- Нажмите кнопку Authorize
- Если требуется, нажмите Allow Access.
- Нажмите Try it out .
-
Будет создан ответ.
agreementId находится в теле ответа:
-
DELETE /agreements/{agreementId}/documents: удаление всех документов, связанных с соглашением. Само соглашение продолжает отображаться на странице «Управление».
- Выберите операцию DELETE/agreements, которую необходимо выполнить.
- Нажмите кнопку OAUTH ACCESS-TOKEN и создайте маркер доступа с областью agreement_retention.
- Укажите agreementId соглашения, которое вы хотите удалить.
- После удаления соглашения текст ответа выглядит как 'no content'.
Если операция DELETE/agreements не включена, вы получите следующий ответ:
"code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",
"message": "Для этой операции требуется активировать несколько параметров учетной записи. Обратитесь к специалистам Acrobat Sign, чтобы активировать эти параметры".
Как загрузить подписанный документ вместе с отчетом об аудите и сопутствующим документом через Acrobat Sign REST API, вместо того чтобы создавать отдельный вызов для загрузки отчета об аудите, используя следующий метод.
-
Перейдите на веб-сайт https://secure.na1.adobesign.com/public/docs/restapi/v5.
-
Нажмите GET /agreements/{agreementId}/combinedDocument.
-
Нажмите кнопку «OAuth Access-token».
-
Маркер доступа генерируется автоматически после принятия авторизации.
-
Укажите agreementId.
-
В разделе attachSupportingDocuments выберите значение true в раскрывающемся списке.
-
В разделе attachAuditReport выберите значение true в раскрывающемся списке.
-
Нажмите Try it out .
Это обеспечивает загрузку объединенного PDF подписанного сопутствующего документа и отчета об аудите.
Для массовой загрузки документов доступен только инструмент экспорта документов, а с помощью API можно загружать документы только по одному. Ниже описан метод API, позволяющий сделать то же самое:
https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument
Шаблоны библиотек и веб-формы
-
Войдите Acrobat Sign как администратор и перейдите по адресу: https://secure.na1.adobesign.com/public/docs/restapi/v6.
-
- Нажмите libraryDocuments и разверните метод GET /libraryDocuments.
- Нажмите кнопку OAUTH ACCESS-TOKEN.
- Включите область library_read:self.
- Нажмите кнопку Authorize
- Если требуется, нажмите Allow Access.
- Нажмите Try it out кнопка
-
Будет создан ответ.
LibraryDocumentId находится в теле ответа:
В Adobe появился новый API PUT/libraryDocuments/ID/me/visibility для управления отображением соглашения (в GET /agreements). В дополнение к функциям, которые обеспечивает DELETE /agreements/ID, новая конечная точка отображения также позволяет пользователю отменить операцию скрытия, то есть снова сделать соглашение видимым.
Можно выполнить подробно описанные ниже действия:
- Перейдите к методу get / libraryDocuments и получите идентификатор соглашения.
- Нажмите put /libraryDocuments/{libraryDocumentId}/me/visibility и укажите следующий запрос в качестве примера:
{
"visibility": "HIDE"
}
. Идентификатор библиотеки скрыт только из get /libraryDocuments, однако он все еще отображается в пользовательском интерфейсе во вкладке «Управление».
- Отправьте запрос в службу поддержки, чтобы включить область для удаления библиотеки.
- API удаляет библиотечный документ. Однако соглашения, созданные с помощью этого библиотечного документа, не затрагиваются.
Создание libraryDocumentID
-
Перейдите по ссылке: https://secure.echosign.com/public/docs/restapi/v5.
-
Нажмите libraryDocuments.
-
Нажмите кнопку OAuth Access-token.
Авторизуйтемаркер доступа для себя, группы или учетной записи.
-
Выберите libraryTemplateType — Document или Form_field_layer.
-
Нажмите Try it out.
Для всех шаблонов можно получить ответ следующим образом. (Скопируйте libraryDocumentId для шаблона библиотеки, который требуется удалить).
{ "libraryDocumentList": [ { "name": "testing fields", "modifiedDate": "2017-08-04T01:06:05-07:00", "scope": "PERSONAL", "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", "libraryTemplateTypes": [ "DOCUMENT" ] },
Удаление шаблонов библиотек
-
Скопируйте libraryDocumentID из тела ответа.
-
Перейдите к Delete libraryDocuments.
-
Нажмите кнопку «OAuth Access-token». Авторизуйте маркер доступа для себя, группы или учетной записи.
-
Вставьте libraryDocumentId в поле Value.
-
Нажмите Try it out.
Шаблон будет удален.Вы получите следующий код ответа: 204.
Можно обновить только веб-формы в состоянии Draft.
-
Создайте виджет с помощью post /widgets.
-
Получите идентификатор виджета из get/widgets.
-
После создания с помощью метода GET /widgets/{widgetId} извлеките Etag из заголовка ответа.
-
В разделе put /widgets/{widgetId} используйте Etag из GET /widgets/{widgetId}. В параметре If-Match введите widgetId и widgetInfo.
{ "fileInfos": [ { "transientDocumentId": "******" } ], "name": "Widht_Name", "status": "DRAFT", "widgetParticipantSetInfo": { "memberInfos": [ { "email": "" } ], "role": "SIGNER" } } -
Примеры использования
-
Создайте вызов get/agreements с соответствующим значением x-api-user.
-
В теле ответа найдите выходные данные для соглашения на подпись, для которого вы хотите найти URL-адрес для подписания, и запишите идентификатор соглашения.
-
Создайте вызов get/agreements/{agreementId}/signingUrls, используя идентификатор соглашения, полученный от вызова get/agreements.
Результат
В выходных данных будет указан адрес электронной почты подписывающих сторон и URL-адрес электронного подписания.