开发者中心

获取创建文件模版页面链接

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"
  }
}