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

Получить ссылку на страницу создания шаблона файла

POST /esignglobal/v1/templates/create

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

Получение ссылки на страницу создания шаблона файла.

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

Примечания

  • fileKey — ключ файла (KEY), полученный через интерфейс загрузки файлов, используется для указания файла, на основе которого создается данный шаблон.
  • docTemplateType по умолчанию равен 0, что означает PDF-шаблон; при передаче 2 указывается HTML-шаблон, что подходит для сценариев динамического добавления строк в таблицу и заполнения их данными.
  • После успешного вызова интерфейса возвращается docTemplateCreateUrl, данная ссылка имеет ограниченный срок действия, рекомендуется использовать её сразу после получения, не рекомендуется сохранять в кэше на длительное время.
  • Разработчик может с помощью redirectUrl указать страницу перехода после завершения создания шаблона.

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

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

Тип

Обязательное поле

Описание

docTemplateName

string

true

Название шаблона файла, может быть задано произвольно.

fileKey

string

true

KEY файла, получаемый через интерфейс загрузки файлов.

docTemplateType

int

false

Тип шаблона файла, значение по умолчанию: 0

0: PDF-шаблон.

2: HTML-шаблон, подходит для сценариев динамического добавления строк в таблицу и заполнения содержимого.

redirectUrl

string

false

Ссылка для перехода после создания шаблона, должна быть валидным URL.

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

{
  "docTemplateName": "Sales Contract Template",
  "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
  "docTemplateType": 0,
  "redirectUrl": "https://example.com/template/create/callback"
}

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

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

Тип

Описание

code

int

Код состояния.

message

string

Информация об ответе.

data

object

Данные ответа.

 

docTemplateId

string

ID созданного шаблона файла.

 

docTemplateCreateUrl

string

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

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

{
  "code": 0,
  "message": "success",
  "data": {
    "docTemplateId": "template_123456789",
    "docTemplateCreateUrl": "https://app.esignglobal.com/template/create?token=example"
  }
}