Центр разработчиков

Создать представление отправки конверта

POST /esignglobal/v1/envelopes/views/sender

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

Создает представление отправителя конверта по его ID. Разработчики могут интегрировать представление отправки в свои сторонние приложения через страницу, полученную с помощью этого интерфейса.

  1. Процесс подписания, инициированный через страницу инициирования подписания, полученную через это представление, заполняется информацией о пользователе, полученной из Access Token в oauth.
  2. Перед вызовом этого интерфейса необходимо сначала создать конверт со статусом черновика через интерфейс создания процесса подписания.
  3. После создания ID процесса подписания можно настроить конверт с помощью интерфейсов добавления файлов для подписания, добавления сторон для подписания и т. д.
  4. Страница инициирования, сгенерированная этим представлением, поддерживает встраивание iframe и webview. Язык страницы по умолчанию — английский.
  5. Вызов этого интерфейса не поддерживает процессы подписания, включающие молчаливое подписание подписантом.

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

Название параметра

Тип

Обязательно

Описание

envelopeId

string

true

ID процесса подписания. Разрешено передавать только ID процессов подписания со статусом 0 - создан (черновик).

returnUrl

string

true

Адрес перенаправления после завершения отправки процесса подписания (длина 2048), должен соответствовать протоколам https / http.

settingsobjectfalseПользовательские настройки страницы отправки
 startingPagestringfalseОтправить начальную страницу представления, по умолчанию preparePage.
preparePage - страница настройки основной информации
taggingPage - страница настройки элементов управления подписью
 submitActionstringfalseОтправить, по умолчанию send
save - сохранить, на странице отображается кнопка сохранения, скрываются кнопки, связанные с отправкой;
send - отправить, на странице отображаются кнопки send now, send, send later, скрывается кнопка сохранения;
 showBackButtonbooleanfalseПоказывать ли кнопку «Назад» на странице Tagging Page, по умолчанию true.
true - показывать
false - не показывать
 

lockedArea

arrayfalse

Информация, которую нельзя изменить в senderView, по умолчанию пуста. Перечислимые значения включают:

document - Подписанный файл

signerInfo - Информация о подписавшем

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

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

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

Название параметра

Тип

Описание

url

string

Адрес страницы создания конверта

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

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа