eSign.AIeSign.AI
Центр разработчиков

Добавить файл подписи

POST /esignglobal/v1/envelope/files/addSignFiles

Описание интерфейса

Пока конверт не открыт, в него можно добавлять файлы для подписания. В уже открытых конвертах добавление файлов для подписания не поддерживается.

Параметры запроса

Имя параметра

Тип

Обязательный

Примечание

envelopeId

string

true

ID конверта

signFiles

array

true

Коллекция информации о файлах для подписания; порядок отображения соответствует порядку добавления файлов.

 

fileKey

string

true

fileKey файла для подписания, поддерживается только формат PDF

 documentFieldsarrayfalseСписок элементов управления на уровне документа. Используется для добавления элементов управления на уровне документа, не привязанных к конкретному подписанту, на указанный файл.
  

fieldType

string

false

Тип элемента управления. Передача значения eMeterai указывает на элемент управления налогом по бумажным маркам Индонезии.

  

pageNo

string

false

Номер страницы, на которой находится элемент управления. Для элемента управления налогом по бумажным маркам Индонезии допускается указание только одной страницы; необходимо передать один номер страницы. Форматы непрерывных или разрывных диапазонов страниц, такие как 1-3 или 1,3, не поддерживаются.

  posXfloatfalseСмещение по оси X; началом координат является левый нижний угол страницы. Диапазон координат совпадает с диапазоном координат других элементов управления.
  posYfloatfalseСмещение по оси Y; началом координат является левый нижний угол страницы. Диапазон координат совпадает с диапазоном координат других элементов управления.

Пример запроса

{   
  "envelopeId": "9fbe6c8190824227bde29136b0145c81",
  "signFiles": [
  {
    "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
  }
]
}

Параметры ответа

Имя параметра

Тип

Описание

code

int

Код бизнес-операции: 0 означает успех, ненулевое значение — ошибку.

message

string

Бизнес-информация

[Внимание] Оценку ошибок следует проводить по коду (code), а не по совпадению сообщения (message), так как сообщение может быть изменено.

data

object

Бизнес-данные

Пример ответа

{
    "code": "0",
    "message": "success",
    "data": null
}