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

1. Выполните вход в Acrobat Sign.
2. Перейдите в Acrobat Sign API > документация REST API.
3. Выберите версию 5.
4. В методе 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://helpx.adobe.com/ru/enterprise/help/users.html
• https://developer.adobe.com/umapi/

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

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

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

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

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

В ходе вызова 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"

  }

}

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

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

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

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

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

Чтобы создать соглашение с помощью API с состоянием «AUTHORING», выполните следующие действия.

Перейдите к Post /agreements и создайте маркер доступа с необходимыми областями.

Используйте следующий код запроса:

В версии 6 предусмотрен набор API авторинга для создания соглашения. В версии 5 поля форм используются непосредственно в POST /agreements api. Однако в версии 6 пользователь может создать соглашение в состоянии АВТОРИНГА (state = AUTHORING) с помощью POST /agreements версии 6 и использовать PUT /agreements/ID/formFields позже для добавления полей формы в документы этого соглашения.

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

Используйте POST /agreements для создания соглашения. Отправляет его на подпись и возвращает значение agreementID в ответ клиенту. Ниже приведен формат JSON для отправки соглашения с использованием метода аутентификации по телефону.

Данные можно объединить непосредственно в поля формы следующими способами:

• С помощью шаблона библиотеки:
  
  при использовании идентификатора шаблона библиотеки в параметре FileInfo обязательно укажите точное имя поля и относящиеся к нему данные в следующем разделе:

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

Как отправить соглашение с помощью API с предварительно заполненными значениями для определенных полей формы (mergefield)?

Для выполнения этого вызова необходимо сначала выполнить шаг «Добавление промежуточного документа» и получить значение «transientDocumentId» (с помощью secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument) для использования в этом шаге.

• Этот вызов включает раздел «mergeFieldInfo», в котором указаны значения по умолчанию для определенных полей формы.
• Это позволяет предварительно вносить данные из другой системы в вызове API.
• Эти поля в соглашении доступны для редактирования или только для чтения.

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

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

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

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

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}, который позволяет обновить существующее соглашение. Укажите идентификатор промежуточного документа вместе с идентификатором соглашения в следующем коде запроса:

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

Нет.

В нынешнем 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, однако он все еще отображается в пользовательском интерфейсе вкладки «Управление».

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

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

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

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

GET /agreements/{agreementId}/auditTrail

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

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

В 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, однако он все еще отображается в пользовательском интерфейсе во вкладке «Управление».

Создание libraryDocumentID

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