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

Adobe Acrobat Sign API — часто задаваемые вопросы

 

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

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

  1. Заметки о выпуске
  2. Заметки о выпуске
  3. Важные уведомления

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

  1. Краткое руководство для администраторов
  2. Краткое руководство для пользователей
  3. Для разработчиков
  4. Библиотека видеоуроков
  5. Часто задаваемые вопросы

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

  1. Обзор Admin Console
  2. Управление пользователями
    1. Добавление пользователей
      1. Добавление пользователя
      2. Массовое добавление пользователей
      3. Добавление пользователей из каталога
      4. Добавление пользователей из службы MS Azure Active Directory
    2. Создание пользователей, ориентированных на функции
      1. Технические учетные записи — управляемые API
      2. Служебные учетные записи — управляемые вручную
    3. Проверка пользователей с ошибками подготовки
    4. Изменение имени и адреса электронной почты
    5. Изменение участия в группе
    6. Изменение участия в группе с помощью интерфейса группы
    7. Повышение роли пользователя до роли администратора
    8. Типы идентификаторов пользователей и единый вход
    9. Смена удостоверения пользователя
    10. Аутентификация пользователей с помощью Microsoft Azure
    11. Аутентификация пользователей с помощью Google Federation
    12. Профили продуктов
    13. Интерфейс входа 
  3. Параметры учетной записи/группы
    1. Обзор параметров
    2. Глобальные настройки
      1. Идентификатор и уровень учетной записи
      2. Новый интерфейс для получателей
      3. Рабочие процессы самостоятельного подписания
      4. Пакетная отправка
      5. Веб-формы
      6. Настраиваемые рабочие процессы отправки
      7. Рабочие процессы Power Automate
      8. Документы библиотеки
      9. Сбор данных формы с соглашениями
      10. Ограниченная видимость документа
      11. Прикрепление копии подписанного соглашения в формате PDF 
      12. Добавление ссылки в сообщение электронной почты
      13. Добавление изображения в сообщение электронной почты
      14. Файлы, прикрепленные к электронному письму, получат имя
      15. Прикрепление отчета об аудите к документам
      16. Объединение нескольких документов в один
      17. Загрузка отдельных документов
      18. Добавление подписанного документа
      19. Делегирование для пользователей в моей учетной записи
      20. Предоставление права делегирования внешним получателям
      21. Право на подпись
      22. Право на отправку
      23. Полномочия на добавление электронных печатей
      24. Установка часового пояса по умолчанию
      25. Установка формата даты по умолчанию
      26. Пользователи, состоящие в нескольких группах (UMG)
        1. Переход на использование UMG
      27. Разрешения администратора группы
      28. Замена получателя
      29. Отчет об аудите
        1. Обзор
        2. Разрешение доступа без аутентификации на странице проверки транзакции
        3. Включение напоминаний
        4. Включение событий представления
        5. Включение счетчика страниц и вложений в соглашении
      30. Нижний колонтитул транзакции
      31. Сообщения и инструкции в приложении
      32. Файлы PDF с расширенным доступом
      33. Новый интерфейс авторинга
      34. Клиент в области здравоохранения
    3. Настройка учетной записи
      1. Добавление логотипа
      2. Настройка названия и URL-адрес компании
      3. Добавление названия компании
      4. URL-адрес перенаправления после завершения работы с соглашением
    4. Настройки подписи
      1. Корректно отформатированные подписи
      2. Предоставление получателям разрешения на добавление подписи
      3. Подписывающие стороны могут изменять свои имена
      4. Предоставление получателям разрешения на использование своих сохраненных подписей
      5. Пользовательские условия использования и соглашение о неразглашении
      6. Перемещение между получателями по полям форм
      7. Перезапуск процесса работы с документом
      8. Отклонение подписания
      9. Предоставление разрешения на использование штампов
      10. Добавление требования о том, чтобы подписывающие стороны указывали должность или название компании
      11. Предоставление подписывающим сторонам разрешения на печать и размещение рукописной подписи
      12. Отображение сообщений при электронном подписании
      13. Добавление требования о том, чтобы подписанты использовали мобильное устройство для создания подписи
      14. Запрос IP-адресов подписантов
      15. Исключение названия компании и должности из штампа участника
    5. Цифровые подписи
      1. Обзор
      2. Загрузка и подписание в Acrobat
      3. Подписание с помощью цифровых подписей в облаке
      4. Включение метаданных для поставщиков идентификационных данных
      5. Запрещенные поставщики сервисов подписания в облаке
    6. Электронные печати
    7. Цифровое удостоверение
      1. Шлюз цифрового удостоверения
      2. Политика проверки личности
    8. Параметры отчета
      1. Новый интерфейс для работы с отчетами
      2. Настройки классических отчетов
    9. Параметры безопасности
      1. Параметры единого входа
      2. Настройки «Запомнить меня»
      3. Политика пароля для входа
      4. Надежность пароля для входа
      5. Продолжительность веб-сеанса
      6. Тип шифрования PDF
      7. Программный интерфейс
      8. Доступ к сведениям о пользователе и группе
      9. Допустимые диапазоны IP-адресов
      10. Общий доступ к учетной записи
      11. Полномочия на совместное использование учетных записей
      12. Средства управления совместным использованием соглашений
      13. Проверка личности подписывающей стороны
      14. Пароль для подписания соглашения
      15. Надежность пароля для документа
      16. Блокировка подписывающих сторон по геолокации
      17. Аутентификация по телефону
      18. Аутентификация на основе данных (KBA)
      19. Разрешение на извлечение страниц
      20. Истечение срока действия ссылки на документ
      21. Отправка сертификата клиента для веб-перехватчиков и обратных вызовов
      22. Метка времени
    10. Параметры отправки
      1. Отображение страницы отправки после входа
      2. Добавление требования о вводе имени получателя при отправке
      3. Блокировка значений имени для известных пользователей
      4. Допустимые роли получателей
      5. Разрешение электронного заверения
      6. Группы получателей
      7. Получатели в копии
      8. Доступ получателя к соглашению
      9. Обязательные поля
      10. Прикрепление документов
      11. Сведение полей
      12. Изменение соглашений
      13. Название соглашения
      14. Языки
      15. Личные сообщения
      16. Разрешенные типы подписей
      17. Напоминания
      18. Защита паролем для подписанных документов
      19. Отправлять уведомления о соглашении через
      20. Параметры идентификации подписывающей стороны
        1. Обзор
        2. Пароль для подписания
        3. Одноразовый пароль по электронной почте
        4. Аутентификация Acrobat Sign
        5. Аутентификация по телефону
        6. Цифровые подписи в облаке
        7. Аутентификация на основе знаний
        8. Удостоверение личности
        9. Отчет по проверке личности подписывающей стороны
      21. Защита контента
      22. Включение операций Notarize
      23. Истечение срока действия документа
      24. Просмотр, размещение подписей и добавление полей
      25. Порядок подписания
      26. Режим Liquid Mode
      27. Элементы управления для настраиваемого рабочего процесса
      28. Возможности для отправки на странице эл. подписания
      29. URL перенаправления при подтверждении после подписания
    11. Шаблоны сообщений
    12. Требования биофармацевтической отрасли
      1. Обзор
      2. Запрос аутентификации
      3. Основания для подписания
    13. Интеграция с рабочим процессом
    14. Настройки нотариального заверения
    15. Интеграция платежной системы
    16. Сообщения для подписывающих сторон
    17. Параметры SAML
      1. Конфигурация SAML
      2. Установка Microsoft Active Directory Federation Service
      3. Установка Okta
      4. Установка OneLogin
      5. Установка Oracle Identity Federation
    18. Управление данными
    19. Настройки меток времени
    20. Внешний архив
    21. Языки учетной записи
    22. Параметры эл. почты
      1. Изображения верхнего и нижнего колонтитула для сообщений электронной почты
      2. Разрешение персональных нижних колонтитулов для сообщений электронной почты
      3. Настройка письма «Запрос на подписание»
      4. Настройка полей «Кому» и «Копия»
      5. Включение уведомлений без ссылок
      6. Настройка шаблонов электронных писем
    23. Переход с домена с echosign.com на adobesign.com
    24. Настройка параметров для получателей
  4. Руководство по нормативным требованиям
    1. Специальные возможности
      1. Соответствие требованиям для специальных возможностей
      2. Создание форм со специальными возможностями с помощью Acrobat для настольных ПК
      3. Создание AcroForms со специальными возможностями
    2. Закон об ответственности и переносе данных о страховании здоровья граждан (HIPAA)
    3. Общий регламент по защите данных (GDPR)
      1. Обзор GDPR
      2. Исправление пользователя
      3. Исправление соглашений пользователя    
    4. 21 CFR, часть 11 и приложение EudraLex 11
      1. 21 CRF, часть 11, комплект проверки
      2. Руководство по 21 CFR и приложению EudraLex 11
      3. Анализ общих обязанностей
    5. Клиенты в области здравоохранения
    6. Поддержка IVES
    7. Хранящиеся соглашения
    8. Рекомендации для ЕС и Великобритании
      1. Трансграничные операции и eIDAS в ЕС и Великобритании
      2. Требования HMLR к документам, подписанным электронной подписью
      3. Влияние выхода Великобритании из Евросоюза на законы об электронной подписи в Великобритании
  5. Массовая загрузка документов
  6. Подтверждение домена 
  7. Ссылки на сообщения о нарушениях

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

  1. Параметры получателя
    1. Отменить уведомления по электронной почте
    2. Параметры на странице эл. подписания
      1. Параметры на странице эл. подписания
      2. Открытие для чтения соглашения без полей
      3. Отказ от подписания соглашения
      4. Передача полномочий по подписанию
      5. Перезапуск соглашения
      6. Загрузка PDF-файл соглашения
      7. Просмотр истории соглашения
      8. Просмотр сообщений о соглашении
      9. Преобразование электронной подписи в рукописную
      10. Преобразование рукописной подписи в электронную
      11. Навигация по полям формы
      12. Очистка полей формы
      13. Увеличение страниц электронного документа и навигация по ним
      14. Изменение языка, используемого в инструментах соглашения и сведениях о нем
      15. Просмотр юридической информации
      16. Настройка параметров файлов cookie Acrobat Sign
  2. Отправка соглашений  
    1. Обзор страницы отправки
    2. Отправка соглашения только себе
    3. Отправка соглашения другим пользователям
    4. Рукописная подпись
    5. Порядок подписания получателями
    6. Пакетная отправка
      1. Обзор функции «Пакетная отправка»
      2. Пакетная отправка — настройка родительского шаблона
      3. Пакетная отправка — настройка файла CSV
      4. Отмена операции пакетной отправки
      5. Добавление напоминаний для пакетной отправки
      6. Отчеты для пакетной отправки
  3. Создание полей в документах
    1. Среда авторинга внутри приложения
      1. Автоматическое обнаружение полей
      2. Перетаскивание полей в среде авторинга
      3. Назначение полей форм получателям
      4. Предварительно заполняемая роль
      5. Применение полей с помощью шаблона для повторного использования
      6. Перенос полей в новый шаблон библиотеки
      7. Обновленный интерфейс авторинга при отправке соглашений
    2. Создание форм и текстовых тегов
    3. Создание форм с помощью Acrobat (AcroForms)
      1. Создание AcroForm
      2. Создание файлов PDF со специальными возможностями
    4. Поля
      1. Типы полей
        1. Стандартные типы полей
        2. Встроенные изображения
        3. Изображения штампа
      2. Внешний вид содержимого поля
      3. Проверки полей
      4. Значения маскируемых полей
      5. Настройка условий отображения/скрытия
      6. Вычисляемые поля 
    5. Часто задаваемые вопросы об авторинге
  4. Подписание соглашений
    1. Подписание отправленных вам соглашений
    2. Заполнение и подписание
    3. Самостоятельное подписание
  5. Управление соглашениями
    1. Управление видом страницы
    2. Передача соглашений
    3. Замена получателей
    4. Ограниченная видимость документа
    5. Отмена соглашения 
    6. Создание новых напоминаний
    7. Просмотр напоминаний
    8. Отмена напоминания
    9. Доступ к потокам Power Automate
    10. Другие действия...
      1. Как работает поиск
      2. Просмотр соглашения
      3. Создание шаблона на основе соглашения
      4. Скрытие/отображение соглашений в представлении
      5. Добавление подписанного соглашения
      6. Изменение файлов или полей в отправленном соглашении
      7. Изменение метода аутентификации получателя
      8. Добавление или изменение срока действия
      9. Добавление примечания к соглашению
      10. Предоставление доступа к отдельному соглашению
      11. Отмена доступа к соглашению
      12. Загрузка отдельного соглашения
      13. Загрузка отдельных файлов соглашения
      14. Загрузка отчета об аудите для соглашения
      15. Загрузка содержимого полей для соглашения
  6. Отчет об аудите
  7. Отчеты и экспорт данных
    1. Обзор
    2. Предоставление пользователям доступа к отчетам
    3. Диаграммы отчетов
      1. Создание нового отчета
      2. Отчеты по соглашениям
      3. Отчеты о транзакциях
      4. Отчет о действиях с настройками
      5. Редактирование отчета
    4. Экспорт данных 
      1. Создание нового экспорта данных
      2. Экспорт данных веб-форм
      3. Редактирование экспорта данных
      4. Обновление содержимого для экспорта данных
      5. Загрузка экспорта данных
    5. Переименование отчета или экспорта
    6. Дублирование отчета или экспорта
    7. Назначение отчета или экспорта
    8. Удаление отчета или экспорта
    9. Проверка использования транзакций

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

  1. Веб-формы 
    1. Создание веб-формы
    2. Изменение веб-формы
    3. Отключение/включение веб-формы
    4. Скрытие/отображение веб-формы
    5. Поиск URL-адреса или кода сценария 
    6. Предварительное заполнение полей в веб-формы с помощью параметров URL
    7. Сохранение веб-формы для заполнения позднее
    8. Изменение размера веб-формы
  2. Шаблоны для повторного использования (Шаблоны библиотеки) 
    1. Формы государственных учреждений США в библиотеке Acrobat Sign
    2. Создание шаблона библиотеки
    3. Изменение имени шаблона библиотеки
    4. Изменение типа шаблона библиотеки
    5. Изменение уровня доступа к шаблону библиотеки
    6. Копирование, редактирование и сохранение общего шаблона
    7. Загрузка данных для агрегированного поля в шаблоне библиотеки
  3. Передача прав владения веб-формами и шаблонами библиотек
  4. Рабочие процессы Power Automate 
    1. Обзор интеграции с Power Automate и включенных в нее прав
    2. Включение интеграции Power Automate
    3. Контекстные действия на странице «Управление»
    4. Отслеживание использования Power Automate
    5. Создание потока (с примерами)
    6. Триггеры, используемые для потоков
    7. Импорт потоков извне Acrobat Sign
    8. Управление потоками
    9. Редактирование потоков
    10. Общий доступ к потокам
    11. Отключение и включение потоков
    12. Удаление потоков
    13. Полезные шаблоны
      1. Только администратор
        1. Сохранение всех заполненных документов в SharePoint
        2. Сохранение всех заполненных документов в OneDrive для бизнеса
        3. Сохранение всех заполненных документов на Google Диске
        4. Сохранение всех заполненных документов в Dropbox
        5. Сохранение всех заполненных документов в Box
      2. Архивирование соглашений
        1. Сохранение заполненных документов в SharePoint
        2. Сохранение заполненных документов в OneDrive для бизнеса
        3. Сохранение заполненных документов на Google Диске
        4. Сохранение всех заполненных документов в Dropbox
        5. Сохранение заполненных документов в Box
      3. Архивирование соглашений веб-форм
        1. Сохранение заполненных документов веб-форм в библиотеке SharePoint
        2. Сохранение всех заполненных документов в OneDrive для бизнеса
        3. Сохранение заполненных документов на Google Диске
        4. Сохранение заполненных документов веб-форм в Box
      4. Извлечение данных соглашения
        1. Извлечение данных полей формы из подписанного документа и обновление листа Excel
      5. Уведомления о соглашениях
        1. Отправка по электронной почте настраиваемых уведомлений с содержимым соглашения и подписанным соглашением
        2. Получение уведомлений Adobe Acrobat Sign в канале Teams
        3. Получение уведомлений Adobe Acrobat Sign в Slack
        4. Получение уведомлений Adobe Acrobat Sign в Webex
      6. Создание соглашения
        1. Создание документа на основе формы Power Apps и шаблона Word, отправка на подпись
        2. Создание соглашения на основе шаблона Word в OneDrive и получение подписи
        3. Создание соглашения по выбранной строке Excel, отправка на проверку и подпись
  5. Настраиваемые рабочие процессы отправки
    1. Обзор настраиваемого рабочего процесса отправки
    2. Создание рабочего процесса отправки
    3. Редактирование рабочего процесса отправки
    4. Активация или деактивация рабочего процесса отправки
    5. Отправка соглашения с помощью рабочего процесса отправки
  6. Предоставление доступа к пользователям и соглашениям
    1. Предоставление доступа к пользователю
    2. Предоставление доступа к соглашению

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

  1.  Обзор интеграции с Acrobat Sign
  2. Acrobat Sign для Salesforce
  3. Acrobat Sign для Microsoft
    1. Acrobat Sign для Microsoft 365
    2. Acrobat Sign для Outlook
    3. Acrobat Sign для Word/PowerPoint
    4. Acrobat Sign для Teams
    5. Acrobat Sign для Microsoft PowerApps и Power Automate
    6. Соединитель Acrobat Sign для Microsoft Search
    7. Acrobat Sign для Microsoft Dynamics
    8. Acrobat Sign для Microsoft SharePoint
  4. Другие интеграции
    1. Acrobat Sign для ServiceNow
    2. Acrobat Sign для HR ServiceNow
    3. Acrobat Sign для SAP SuccessFactors
    4. Acrobat Sign для Workday
    5. Acrobat Sign для NetSuite
    6. Acrobat Sign для VeevaVault
    7. Acrobat Sign для Coupa BSM Suite
  5. Интеграции, управляемые партнерами
  6. Как получить ключ интеграции?

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

  1. Интерфейсы REST API
    1. Документация по методам
    2. Руководство разработчика по SDK
    3. Часто задаваемые вопросы по API    
  2. Веб-перехватчики 
    1. Обзор веб-перехватчиков
    2. Настройка нового веб-перехватчика
    3. Просмотр и изменение веб-перехватчика
    4. Деактивация или повторная активация веб-перехватчика
    5. Удаление веб-перехватчика
    6. Двустороннее шифрование с помощью сертификатов SSL
    7. Веб-перехватчики в API

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

  1. Ресурсы службы поддержки клиентов 
  2. Истории успеха корпоративных клиентов 

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

Ссылки на основную документацию

Полезные ссылки для REST API 6:

Примечание.

Поддержка устаревших 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.

  1. Войдите в Adobe Sign как администратор.

  2. Выберите Учетная запись > Adobe Sign API > Журнал запросов API.

    Журналы API

  1.  Войдите в учетную запись Adobe Sign как администратор.

  2. Выберите Учетная запись > Adobe Sign API > Сведения об API.

  3. Нажмите ссылку Примеры REST API.

    Примечание.

    Чтобы загрузить пакет SDK JavaScript, см. https://github.com/adobe-sign/AdobeSignJsSdk.

Начиная с версии 6, параметр sendTroughWeb (Отправка по Интернету) больше не доступен. Вместо него предусмотрено state (состояние). Это состояние, в котором пребывает документ. Поле состояния можно указать только при выполнении вызовов POST. Оно не возвращается в GET /agreements/{ID} и игнорируется, если указано в вызове PUT /agreements/{ID}. Окончательное состояние соглашения можно получить через GET /agreements/ID.

Состояние(строка) = ['AUTHORING' или 'DRAFT' или 'IN_PROCESS'].

AUTHORING (Авторинг) позволяет пользователю выполнить авторинг документов соглашения перед их отправкой. Операция авторинга означает создание, редактирование или размещение полей формы вместе с их конфигурациями (назначенное лицо, условия, тип данных и т. д.) в документах соглашения. После публикации документа в состоянии «Авторинг» документ отображается в разделе «Черновик» на вкладке «Управление» Adobe Sign.

DRAFT (Черновик) — это временный или примитивный этап окончательного необходимого ресурса, который можно обновить пошагово для создания окончательного ресурса, и не отображаемый в разделе «Черновик» на вкладке «Управление» Adobe Sign. При использовании состояния «Черновик» информация о наборе участника не требуется, и ее можно назначить позже при создании PUT /agreements/agreementId для завершения этого черновика. Этот шаг можно повторять несколько раз, пока не будут получены все необходимые данные для создания соглашения.

IN_PROCESS (В процессе) изменяет статус соглашения на «Отправлено на подпись» и отображается в разделе «Отправлено на подпись» на вкладке «Управление» Adobe Sign.

sendThroughWeb позволяет отправлять соглашение в интерактивном режиме. Различные параметры в поле «options» (Варианты) в запросе POST /agreements версии 5 позволяют пользователю настроить это интерактивное представление (страницу «Отправка»). Все эти параметры конфигурации страницы, такие как fileUploadOptions (Варианты загрузки файла), перемещаются в API POST agreements/ID/views.

Таким образом, вы можете выполнить sendThrough Web, создав соглашение в состоянии 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": "",
  • Обратитесь в службу поддержки Adobe 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

  1. Добавьте (-Dsoapui.https.protocols=SSLv3,TLSv1.2) в файл VMOPTIONS в папке Bin.

  2. Перейдите в папку C:\Program Files\SmartBear\SoapUI-5.2.1\bin  (зависит от того, где установлен интерфейс SOAP). Он может находиться в папке C:\Program Files (x86)).

  3. В файле VMOPTIONS включите полное разрешение на чтение/запись файла.

    VMOPTIONS

  4. Нажмите правой кнопкой мыши на файл VMOPTIONS > «Свойства» > вкладка «Безопасность» > «Выбрать пользователя» > нажмите «Редактировать». (На кнопке «Редактировать» появится значок управления доступом пользователя) > установите все флажки и нажмите «OK».

  5. Повторите эти действия для администраторов, систем и всех пакетов приложений.

  6. Откройте файл с помощью «Блокнота».

  7. Добавьте этот протокол внизу «-Dsoapui.https.protocols=SSLv3,TLSv1.2» и сохраните изменения.

  8. Закройте интерфейс SOAP и перезапустите. При выполнении вызова API он работает без ошибок SSL. (Для проверки выполните тестовый ping-вызов).

Ниже приведены действия по созданию идентификатора клиента и секретного ключа клиента в приложении Adobe Sign.

  1. Войдите в учетную запись Adobe Sign.

  2. Выберите Учетная запись > Adobe Sign API > Приложения API.

    Fnord.

  3. Чтобы создать приложение, нажмите значок «+».

    Fnord.

  4. Введите имя и отображаемое имя.

  5. В разделе «Домен» выберите «ЗАКАЗЧИК» и нажмите «Сохранить».

    Fnord.

  6. Выделите приложение одним щелчком мыши.

  7. Нажмите «Настройка параметров OAuth для приложения».

    Fnord.

  8. Введите URI перенаправления.

  9. Чтобы включить требуемые области, установите соответствующие флажки и нажмите «Сохранить».

  1. Войдите в Adobe Sign как администратор.

  2. Выберите Учетная запись > Adobe Sign API > Сведения об API.

  3. Откройте ссылку Ключ интеграции.

    Перейдите к разделу «Ключ интеграции»

    Примечание.

    Если вы не видите ссылку «Ключ интеграции», обратитесь к своему менеджеру по работе с клиентами, чтобы включить учетную запись.

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

  4. После сохранения ключ находится в: Учетная запись > Личные настройки > Маркеры доступа.

    Отображаются имя ключа и список всех включенных областей.  

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

    • Ключ интеграции — эта ссылка предоставляет буквенный ключ.
    • Отозвать — выполняет отзыв и удаление маркера доступа без возможности восстановления.
    Маркеры доступа — Ключ интеграции

  1. Войдите в учетную запись Adobe Sign.

  2. Выберите «Учетная запись» > «Adobe Sign API» > «Приложения API».

  3. Нажмите значок +, чтобы создать приложение.

    Postman1

  4. Нажмите «Настройка параметров OAuth для приложения».

    Fnord.

  5. Сгенерируйте код авторизации, используя следующую ссылку. Идентификатор клиента, URI перенаправления и области должны совпадать со следующим URL-адресом, выбранным в приложении (не ставьте пробел в followingURL, и сегмент типа «NA1» соответствует принадлежности учетной записи Adobe 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

  6. Если вызов выполнен успешно, выберите код авторизации в адресной строке.

    Fnord.

  7. Загрузите и установите Postman по ссылке  https://www.getpostman.com/apps.

  8. После загрузки и установки нажмите NEW (Новый), чтобы создать POST.

  9. Введите ссылку https://secure.na1.echosign.com/oauth/token в соответствии с принадлежностью вашей учетной записи Adobe Sign.

  10. В поле Headers (Заголовки) введите  Content-Type (Тип контента) как application/x-www-form-urlencoded.

  11. Убедитесь, что в разделе Body (Тело) выбрано x-www-form-urlencoded , введите следующие параметры с соответствующими значениями из приложения, созданного в учетной записи Adobe Sign, и нажмите SEND.

    Fnord.

  12. Если вся информация верна, в ответе возвращается маркер доступа и маркер обновления:

    Fnord.

При выполнении процесса OAuth необходимо выполнить следующие действия:

1. Указать правильный идентификатор клиента и URI перенаправления.
2. Учитывать, что области, указанные в URL-адресе авторизации, должны точно совпадать с областями, указанными в приложении Adobe 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-адрес веб-перехватчика по какой-либо причине отключен, Adobe Sign создает очередь JSON и повторяет попытку загрузки в нарастающем цикле в течение 72 часов.

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

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

 

Чтобы создать веб-перехватчик непосредственно в интерфейсе пользователя Adobe Sign, сначала создайте URL-адрес веб-перехватчика с помощью приложений-функций Azure AD, выполнив следующие действия:

  1. Войдите в систему с помощью учетной записи Microsoft https://portal.azure.com/.

  2. Зарегистрируйтесь в разделе «Приложения-функции» в учетной записи AzureAD.

    Меню Azure

  3. Перейдите в AzureAD и выберите Приложения-функции > нажмите значок + для доступа к функциям.

  4. Выберите «Webhook+API» с Javascript в качестве языка и нажмите «Создать функцию».

    API-интерфейс Azure

  5. Замените файл 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(); 
    };
  6. Нажмите кнопку «Тестировать» в правом углу и укажите следующий заголовок:

    X-AdobeSign-ClientId как ***********************

    Тест API

  7. Нажмите «Сохранить и запустить».

  8. После получения 200 ответов OK со следующим заголовком нажмите «Получить URL-адрес функции».

    200 ответов

  9. Скопируйте URL-адрес и перейдите в интерфейс Adobe Sign > «Веб-перехватчик» > нажмите значок «+», чтобы создать.

  10. Введите следующие данные:

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

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

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

Чтобы выполнить поиск событий, связанных с ресурсом соглашения, сначала отправьте запрос в API для создания agreementAssetEvents с соответствующими параметрами поиска.

Ответ — это первая страница результатов, а также параметр идентификатора поиска и курсор следующей страницы. Его можно использовать для получения результатов на следующих страницах, если они доступны, с помощью API, который извлекает agreementAssetEvents на основе идентификатора поиска.

  1. Откройте документацию по REST API для версии 5.

  2. Перейдите к post/search/agreementAssetEvents и создайте маркер доступа с соответствующей областью.

  3. В коде запроса укажите дату начала и окончания в соответствии с требованиями:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Нажмите кнопку Try it out (Попробовать). Это извлечет идентификаторы ресурсов соглашения, которые также можно использовать в качестве идентификаторов соглашения.


Управление пользователями/учетными записями

  1. Выполните вход в Adobe Sign.
  2. Выберите «Учетная запись» > «Adobe Sign API» > «Документация по API».
  3. Выберите версию 5.
  4. В методе post /users используйте код запроса, указанный для метода
    UserCreationInfo
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Учетные записи Adobe Sign, использующие веб-панель Admin Console (Adobe One) для управления правами пользователей, не могут использовать API Adobe Sign для создания пользователей или управления существующими пользователями.

Adobe One Admin Console использует другой API, а не API Adobe Sign. Дополнительные сведения см. в следующих статьях:

 

Получение идентификатора группы:

  1. Перейдите по ссылке https://secure.na1.echosign.com/public/docs/restapi/v5.

  2. В разделе «Resources and Operations» (Ресурсы и операции) выберите группы.

  3. Нажмите GET /groups.

  4. Нажмите кнопку OAuth Access-token (Маркер доступа OAuth).

  5. Создайте маркер доступа.

  6. Нажмите кнопку Try it out (Попробовать).

    Вы получите следующий ответ с именем группы и идентификатором группы:

    { 
      "groupInfoList": [ 
        { 
          "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
          "groupName": "Default Group" 
        }, 
        { 
          "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
          "groupName": "test" 
        }, 
      ] 
    }

Удаление группы:

  1. Нажмите DELETE /groups/{groupId}.

  2. Чтобы создать маркер доступа, нажмите кнопку OAuth Access-token.

  3. Добавьте идентификатор удаляемой группы, полученный в ответ на предыдущий вызов, в поле groupId.

  4. Нажмите Try it out.

    После удаления группы вы получите ответ: No content (Контент отсутствует).

Примечание.

Невозможно удалить группу, в которую назначен пользователь. По сути, можно удалить только пустую группу. Если в группе есть пользователь, вы получите следующий ответ.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "Эту группу нельзя удалить — она не пустая."

}


Инициирование/отправка документов

Создание промежуточного документа

  1. Перейдите по адресу: https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Нажмите transientDocuments (Промежуточные документы) и разверните метод POST /transientDocuments.

  3. Нажмите кнопку OAuth Access-token.

    Метод API TransientDocument

    • Включите Scopes (Области) для транзакции.
    • Нажмите Authorize (Авторизовать).
    Области применения OAuth

  4. Предоставление доступа

    Если требуется, нажмите Разрешить доступ.

  5. Вы вернетесь на страницу методов API. Значение авторизации будет уже указано.

    • Введите имя файла в поле File-Name.
    • Нажмите кнопку Choose File (Выбрать файл) и загрузите документ для соглашения.
    • Нажмите кнопку Try it out! (Попробовать).
    Try it out!

  6. Будет создан ответ.

    Идентификатор transientDocumentID можно найти в теле ответа:

    Идентификатор промежуточного документа

Создание документа с помощью промежуточного документа

  1. Перейдите по адресу: https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Нажмите agreements (Соглашения) и разверните метод POST /agreements.

    • Нажмите кнопку OAuth Access-token.
    • Включите область OAuth.
    • Нажмите Authorize.
      • Если требуется, нажмите  Allow Access (Разрешить доступ).
  3. Вы вернетесь на страницу методов 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! (Попробовать).
    Метод POST agreement

  4. Будет создан ответ.

    Значение agreementID можно найти в Теле ответа:

    Ответ для метода POST agreement

Ниже приведены действия по добавлению файлов в параметр FileInfo.

  1. Используйте идентификатор промежуточного документа:

    Перейдите к POST/transientDocuments  и загрузите документ для использования из локальной системы.
    Используйте идентификатор промежуточного документа, сгенерированный в разделе File Info в POST/Agreements:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Используйте идентификатор библиотечного документа:

    Перейдите на панель управления. Нажмите «Добавить документ в библиотеку» и сохраните шаблон.
    В разделе «Документация по REST API» нажмите GET /libraryDocuments и извлеките идентификатор библиотеки для создаваемого шаблона.
    В разделе POST/Agreements укажите идентификатор библиотечного документа:

    "libraryDocumentId": "", 
      "libraryDocumentName": "",
  3. Используйте общедоступный URL-адрес:

    Укажите общедоступный URL-адрес для использования в параметре FileInfo:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Перейдите на веб-сайт https://secure.na1.adobesign.com/public/docs/restapi/v6.

  2. Выберите вариант Agreements> POST/agreements. 

  3. Выберите параметр Oauth Access-Token и укажите необходимые области.

  4. После добавления маркера доступа можно использовать следующий код запроса:

    { 
    "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, нет разрешения, необходимого для выполнения этой операции."}

 

Для функции «Отправка от имени» включите «Расширенный общий доступ к учетной записи», чтобы пользователи могли предоставлять разрешения на отправку другим пользователям при совместном использовании учетной записи. Подробнее о расширенном общем доступе к учетной записи см. Включение расширенного общего доступа к учетной записи.

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

Создайте промежуточный документ:

  1. Перейдите на веб-сайт https://secure.adobesign.com/public/docs/restapi/v6.

  2. В разделе transientDocuments нажмите POST /transientDocuments.

  3. Чтобы создать маркер для авторизации, нажмите кнопку OAUTH ACCESS-TOKEN.

  4. В x-on-behalf-of-user укажите адрес электронной почты пользователя, от имени которого вы хотите отправить документ, в следующем формате: email:test@email.com.

  5. Чтобы выбрать файл, нажмите Choose File, а затем нажмите Try it out (Попробовать).

    Вы получаете ответ примерно следующего вида со значением transientDocumentId:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Создание соглашения с помощью промежуточного документа:

  1. В разделе  agreements, нажмите POST /agreements.

  2. Чтобы создать маркер для авторизации, нажмите кнопку OAUTH ACCESS-TOKEN.

  3. В x-on-behalf-of-user укажите адрес электронной почты пользователя, как это было сделано при создании промежуточного документа.

  4. В поле 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" 
      
    }
  1. Выполните вход в Adobe Sign.

  2. Перейдите к «Учетная запись» > «Adobe Sign API» > «Сведения об API» и нажмите «Документация по методу REST API».

    Пользовательский интерфейс веб-перехватчика

  3. Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.

  4. Скопируйте идентификатор промежуточного документа и используйте его в методе 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": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX", 
                "documentURL": null, 
                "libraryDocumentId": null 
            }] 
        } 
    }
  5. Чтобы выполнить запрос 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 позже для добавления полей формы в документы этого соглашения.

Необходимые шаги указаны далее.

  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. Используйте метод 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 
           } 
    ]}

     

    После завершения запроса соглашение будет отправлено указанному получателю.

  1. Выполните вход в Adobe Sign.

  2. Перейдите к «Учетная запись» > «Adobe Sign API» > «Сведения об API» и нажмите «Документация по методу REST API».

    Пользовательский интерфейс веб-перехватчика

  3. Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.

  4. Скопируйте идентификатор промежуточного документа и используйте его в методе 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 
      
                } 
            ] 
        } 
    }
  5. Чтобы выполнить запрос JSON, нажмите кнопку Try it out.

    Пользовательский интерфейс веб-перехватчика

    Правильный JSON возвращает ответ с идентификатором соглашения.

    Пользовательский интерфейс веб-перехватчика

  1. Выполните вход в Adobe Sign.

  2. Перейдите к «Учетная запись» > «Adobe Sign API» > «Сведения об API» и нажмите «Документация по методу REST API».

    Fnord.

  3. Выполните POST /transientDocuments, загрузите файл и создайте идентификатор промежуточного документа.

  4. Скопируйте идентификатор промежуточного документа и используйте его в методе 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": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX" 
            }] 
        } 
    }
  5. Чтобы выполнить запрос JSON, нажмите кнопку Try it out.

    Fnord.

    Правильный JSON возвращает ответ с идентификатором соглашения.

    Fnord.

  6. Чтобы открыть соглашение в режиме авторинга, скопируйте URL-адрес и вставьте его в адресную строку браузера.

  7. Перетащите поля формы в нужное место.

  8. Чтобы отправить соглашение на подпись, нажмите «Отправка». 

Используйте 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": "Adobe 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.
  • Эти поля в соглашении доступны для редактирования или только для чтения.

 

Предварительные условия:

  1. Идентификатор промежуточного документа
  2. Имена полей и их значения

 

Пример вызова запроса:

 

Запрос:

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 и выполните следующие действия:

  1. Перейдите в документацию по REST API версии 6 и выберите метод
    put /megaSigns/{megaSignId}/state.
  2. Укажите значение авторизации, а также If-Match и значение megasignID.
    • Для получения megasignID используйте get /megaSigns.
    • Для получения If-Match используйте get /megaSigns/{megaSignId} и под заголовком найдите «Etag».
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }

Для успешной регистрации веб-перехватчика его URL-адрес отвечает на этот запрос на проверку, используя код ответа 2XX, а также может отправить одно и то же значение идентификатора клиента одним из следующих двух способов:

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

Adobe Sign получает ответ 2xx со значением  X-AdobeSign-ClientId.Пользователь может проверить, правильно ли оно настроено в веб-перехватчике.

URL-адрес веб-перехватчика не отвечает, как ожидается. Для каждого уведомления Post, отправленного Adobe Sign, URL-адрес в ответ отправляет код статуса 2XX и тот же идентификатор клиента, отправленный в заголовках запросов (X-AdobeSign-ClientId), в заголовках ответов.

Полную информацию можно найти по следующей ссылке:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md.

Если URL-адрес не соответствует данному протоколу, Adobe Sign интерпретирует это как то, что он не подтвердил запрос и не попытался перенести его в соответствии с надежной политикой.

Если веб-перехватчик не отвечает, и превышено максимальное время повтора или максимальный интервал повтора, веб-перехватчик отключается.

Эта работа лицензируется по лицензии Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported.  Публикации Twitter™ и Facebook не подпадают под условия Creative Co.


Управление/получение информации о соглашениях

Чтобы изменить документ, который уже отправлен на подпись, используйте метод PUT /agreements/{agreementId}, который позволяет обновить существующее соглашение. Укажите идентификатор промежуточного документа вместе с идентификатором соглашения в следующем коде запроса:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Ниже приведены инструкции по обновлению состояния с «AUTHORING» на «IN_PROCESS» с помощью Put /agreements/{agreementId}/state.

  1. Получите идентификатор соглашения с помощью метода POST/Agreement.

  2. Используйте Get /agreements/{agreementId}, чтобы получить актуальный ETag.

  3. Перейдите к  Put /agreements/{agreementId}/state и укажите следующую информацию: "state": "IN_PROCESS".

Нет.

В нынешнем REST API нет метода для загрузки подписанной копии.

Отправитель должен загрузить подписанную копию со страницы Управление.

DELETE /agreements/ID раньше позволял скрывать соглашение со страницы управления.

В Adobe появился новый API PUT /agreements/ID/me/visibility для управления отображением соглашения (в GET /agreements). В дополнение к функциям, которые обеспечивает DELETE /agreements/ID, новая конечная точка отображения также позволяет пользователю отменить операцию скрытия, то есть снова сделать соглашение видимым. 

Другие возможные действия подробно описаны далее.

  1. Перейдите к методу get /agreements и получите идентификатор соглашения.
  2. Нажмите put /agreements/{agreementId}/me/visibility и укажите следующий запрос в качестве примера:
    {
      "visibility": "HIDE"
    }
    . Идентификатор соглашения скрыт только из get /libraryDocuments, однако он все еще отображается в пользовательском интерфейсе вкладки «Управление».
Примечание.

По умолчанию функция хранения в API не включена.

Чтобы включить операцию DELETE/agreements , обратитесь к своему менеджеру по работе с клиентами с запросом на включение функции хранения в API для учетной записи.

Для получения дополнительной информации о включении функции хранения для вашей учетной записи см.Adobe Sign — Хранение документов.

  1. Войдите в Adobe Sign как администратор и перейдите по ссылке:https://secure.adobesign.com/public/docs/restapi/v6.

    • Нажмите agreeements и разверните GET /agreements.
    • Нажмите кнопку OAUTH ACCESS-TOKEN.
    • Включите область agreement_read:self.
    • Нажмите кнопку Authorize (Авторизация).
      • Если требуется, нажмите  Allow Access (Разрешить доступ).
    • Нажмите кнопкуTry it out! (Попробовать).
    Метод Get Agreement

  2. Будет создан ответ.

    agreementId находится в теле ответа:

    Ответ на Get Agreement

  3. DELETE /agreements/{agreementId}/documents: удаление всех документов, связанных с соглашением. Само соглашение продолжает отображаться на странице «Управление».

    • Выберите операцию DELETE/agreements, которую необходимо выполнить.
    • Нажмите кнопку OAUTH ACCESS-TOKEN и создайте маркер доступа с областью agreement_retention.
    • Укажите agreementId соглашения, которое вы хотите удалить.
    • После удаления соглашения текст ответа выглядит как 'no content'.

Если операция DELETE/agreements не включена, вы получите следующий ответ:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "Для этой операции требуется активировать несколько параметров учетной записи. Обратитесь к специалистам Adobe Sign, чтобы активировать эти параметры".

Как загрузить подписанный документ вместе с отчетом об аудите и сопутствующим документом через Adobe Sign REST API, вместо того чтобы создавать отдельный вызов для загрузки отчета об аудите, используя следующий метод.

GET /agreements/{agreementId}/auditTrail

  1. Перейдите на веб-сайт https://secure.na1.adobesign.com/public/docs/restapi/v5.

  2. Нажмите GET /agreements/{agreementId}/combinedDocument.

  3. Нажмите кнопку OAuth Access-token (Маркер доступа OAuth).

  4. Маркер доступа генерируется автоматически после принятия авторизации.

  5. Укажите agreementId.

  6. В разделе attachSupportingDocuments выберите значение true в раскрывающемся списке.

  7. В разделе attachAuditReport выберите значение true в раскрывающемся списке.

  8. Нажмите кнопкуTry it out! (Попробовать).

    Получение объединенных документов

    Это обеспечивает загрузку объединенного PDF подписанного сопутствующего документа и отчета об аудите.

Для массовой загрузки документов доступен только инструмент экспорта документов, а с помощью API можно загружать документы только по одному. Ниже описан метод API, позволяющий сделать то же самое:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument


Шаблоны библиотек и веб-формы

  1. Войдите в Adobe 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! (Попробовать).
    Метод Get LibraryDocument

  2. Будет создан ответ.

    LibraryDocumentId находится в теле ответа:

    Ответ на Get LibraryDocument

В Adobe появился новый API PUT/libraryDocuments/ID/me/visibility для управления отображением соглашения (в GET /agreements). В дополнение к функциям, которые обеспечивает DELETE /agreements/ID, новая конечная точка отображения также позволяет пользователю отменить операцию скрытия, то есть снова сделать соглашение видимым.

Другие возможные действия подробно описаны далее.

  1. Перейдите к методу get / libraryDocuments и получите идентификатор соглашения.
  2. Нажмите put /libraryDocuments/{libraryDocumentId}/me/visibility и укажите следующий запрос в качестве примера:
    {
      "visibility": "HIDE"
    }
    . Идентификатор библиотеки скрыт только из get /libraryDocuments, однако он все еще отображается в пользовательском интерфейсе во вкладке «Управление».
Примечание.
  • Отправьте запрос в службу поддержки, чтобы включить область для удаления библиотеки.
  • API удаляет библиотечный документ. Однако соглашения, созданные с помощью этого библиотечного документа, не затрагиваются.


Создание libraryDocumentID

  1. Перейдите по ссылке: https://secure.echosign.com/public/docs/restapi/v5.

  2. Нажмите libraryDocuments (Библиотечные документы).

  3. Нажмите кнопку OAuth Access-token.

    Авторизуйтемаркер доступа для себя, группы или учетной записи.

  4. Выберите libraryTemplateType (Тип шаблона библиотеки) — Document (Документ) или Form_field_layer (слой полей формы).

  5. Нажмите кнопку Try it out (Попробовать).

    Для всех шаблонов можно получить ответ следующим образом. (Скопируйте libraryDocumentId для шаблона библиотеки, который требуется удалить).

    { 
      "libraryDocumentList": [ 
        { 
          "name": "testing fields", 
          "modifiedDate": "2017-08-04T01:06:05-07:00", 
          "scope": "PERSONAL", 
          "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
          "libraryTemplateTypes": [ 
            "DOCUMENT" 
          ] 
        },


Удаление шаблонов библиотек

  1. Скопируйте libraryDocumentID из тела ответа.

  2. Перейдите к Delete libraryDocuments.

  3. Нажмите кнопку OAuth Access-token (Маркер доступа OAuth). Авторизуйте маркер доступа для себя, группы или учетной записи.

  4. Вставьте libraryDocumentId в поле Value (Значение).

  5. Нажмите Try it out (Попробовать). 
    Шаблон будет удален.

    Вы получите следующий код ответа: 204.

Примечание.

Можно обновить только веб-формы в состоянии Черновик.

  1. Создайте виджет с помощью post /widgets.

  2. Получите идентификатор виджета из get/widgets.

  3. После создания с помощью метода GET /widgets/{widgetId} извлеките Etag из заголовка ответа.

    Foo

  4. В разделе put  /widgets/{widgetId} используйте Etag из GET /widgets/{widgetId}. В параметре If-Match введите widgetId и widgetInfo.

    Foo

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "******" 
        } 
      ], 
      "name": "Widht_Name", 
      "status": "DRAFT", 
      "widgetParticipantSetInfo": { 
        "memberInfos": [ 
          { 
            "email": "" 
          } 
        ], 
        "role": "SIGNER" 
      } 
    }


Примеры использования

  1. Создайте вызов get/agreements с соответствующим значением x-api-user.

  2. В теле ответа найдите выходные данные для соглашения на подпись, для которого вы хотите найти URL-адрес для подписания, и запишите идентификатор соглашения.

  3. Создайте вызов get/agreements/{agreementId}/signingUrls, используя идентификатор соглашения, полученный от вызова get/agreements.

     

    Результат

    В выходных данных будет указан адрес электронной почты подписывающих сторон и URL-адрес электронного подписания.

    Метод Get Agreement

 Adobe

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

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