eSign.AIeSign.AI
開発者センター

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

POST /esignglobal/v1/templates/edit

API説明

開発者は本APIを通じて、指定のファイルテンプレートの編集ページリンクを取得できます docTemplateEditUrl、当該リンクを開き、担当者がページ上で既存のファイルテンプレートを編集できるようにします。

注意事項

  • docTemplateId テンプレートIDは、現在連携中のアカウントでアクセス権限のある有効なテンプレートである必要があります。
  • API呼び出しに成功すると、 が返されます。 docTemplateEditUrl、当該リンクには有効期限がありますため、取得後は直ちにご使用ください。長時間のキャッシュは推奨されません。
  • 開発者は を通じて redirectUrl テンプレート編集完了後の遷移先ページを指定します。

リクエストパラメータ

パラメータ名

必須/任意

説明

docTemplateId

string

true

ファイルテンプレートIDは、現在連携中のアカウント内の有効なテンプレートである必要があります。

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