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

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

POST /esignglobal/v1/templates/edit

Описание API

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

Примечания

  • docTemplateId является идентификатором шаблона документа; он должен быть действительным шаблоном, к которому у учетной записи текущего интегратора есть права доступа.
  • После успешного вызова интерфейса возвращается docTemplateEditUrl; эта ссылка имеет ограниченный срок действия, рекомендуется использовать её сразу после получения, не рекомендуется длительное хранение в кэше.
  • Разработчик может с помощью redirectUrl указать страницу перехода после завершения редактирования шаблона.

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

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

Тип

Требуется

Описание

docTemplateId

string

true

Идентификатор шаблона документа; должен быть действительным шаблоном в рамках учетной записи текущего интегратора.

redirectUrl

string

false

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

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

{
  "docTemplateId": "template_123456789",
  "redirectUrl": "https://example.com/template/edit/callback"
}

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

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

Тип

Описание

code

int

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

message

string

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

data

object

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

data.docTemplateEditUrl

string

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

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

{
  "code": 0,
  "message": "success",
  "data": {
    "docTemplateEditUrl": "https://app.esignglobal.com/template/edit?token=example"
  }
}