開發者中心

獲取建立檔案範本頁面連結

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