ファイルテンプレート作成ページのリンクを取得

POST /esignglobal/v1/templates/create

API説明

ファイルテンプレート作成ページのリンクを取得します。

開発者はこのAPIを使用して、有効期限付きのファイルテンプレート作成ページリンクを取得できます docTemplateCreateUrl、そのリンクを開き、担当者がページ上で指定されたファイルに基づいてファイルテンプレートを作成できるようにします。

注意事項

fileKey はファイルアップロードAPIで取得したファイルKEYであり、今回のテンプレート作成の基となるファイルを指定するために使用します。
docTemplateType デフォルトは 0、PDFテンプレートを示します。に渡すと 2 HTMLテンプレートとなり、テーブル行を動的に追加して内容を埋めるシナリオに適しています。
API呼び出し成功後に返されるのは docTemplateCreateUrl、このリンクには有効期限があり、取得後すぐに使用することを推奨し、長時間のキャッシュは推奨しません。
開発者は redirectUrl を使用して、テンプレート作成完了後の遷移先ページを指定できます。

リクエストパラメータ

パラメータ名	タイプ	必須かどうか	説明
docTemplateName	string	true	ファイルテンプレート名。カスタマイズ可能です。
fileKey	string	true	ファイルKEY。ファイルアップロードAPIで取得します。
docTemplateType	int	false	ファイルテンプレートタイプ。デフォルト値は `0`。 `0`：PDF テンプレートです。 `2`：HTML テンプレート。テーブル行を動的に追加して内容を埋め込むシナリオに適しています。
redirectUrl	string	false	テンプレート作成完了後の遷移先URL。有効な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"
  }
}