eSign.AIeSign.AI
Entwicklerzentrum

Link zur Seite zum Erstellen einer Dateivorlage abrufen

POST /esignglobal/v1/templates/create

Schnittstellenbeschreibung

Ruft den Link zur Seite zum Erstellen von Datei-Vorlagen ab.

Entwickler können über diese Schnittstelle einen zeitlich begrenzten Link zur Datei-Vorlagen-Erstellungsseite erhalten docTemplateCreateUrl,und diesen Link öffnen, damit der Benutzer auf der Seite basierend auf einer angegebenen Datei eine Vorlage erstellen kann.

Hinweise

  • fileKey ist der Datei-KEY, der über die Upload-Schnittstelle ermittelt wurde und verwendet wird, um die Datei anzugeben, auf der diese Vorlagenerstellung basiert.
  • docTemplateType standardmäßig 0,steht für eine PDF-Vorlage; bei Übermittlung von 2 wird eine HTML-Vorlage angezeigt, die sich für Szenarien eignet, in denen Tabellenzeilen dynamisch hinzugefügt und mit Inhalten gefüllt werden sollen.
  • Nach erfolgreichem Aufruf der Schnittstelle wird zurückgegeben docTemplateCreateUrl,ist dieser Link nur begrenzt gültig. Es wird empfohlen, ihn sofort nach dem Abruf zu verwenden. Ein langfristiges Caching wird nicht empfohlen.
  • Entwickler können über redirectUrl die Weiterleitungsseite nach Abschluss der Vorlagenerstellung angeben.

Anfrageparameter

Parametername

Typ

Erforderlich

Beschreibung

docTemplateName

string

true

Name der Dateivorlage, kann individuell angepasst werden.

fileKey

string

true

Datei-KEY, wird über die Upload-Schnittstelle abgerufen.

docTemplateType

int

false

Typ der Dateivorlage, Standardwert ist 0

0: PDF-Vorlage.

2: HTML-Vorlage, geeignet für Szenarien, in denen Tabellenzeilen dynamisch hinzugefügt und Inhalte gefüllt werden.

redirectUrl

string

false

Weiterleitungslink nach Abschluss der Vorlagenerstellung, muss eine gültige URL sein.

Anfragebeispiel

{
  "docTemplateName": "Sales Contract Template",
  "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c",
  "docTemplateType": 0,
  "redirectUrl": "https://example.com/template/create/callback"
}

Antwortparameter

Parametername

Typ

Beschreibung

code

int

Statuscode.

message

string

Antwortinformation.

data

object

Antwortdaten.

 

docTemplateId

string

ID der neu erstellten Dateivorlage.

 

docTemplateCreateUrl

string

Link zur Seite zum Erstellen einer Dateivorlage, nur vorübergehend gültig.

Antwortbeispiel

{
  "code": 0,
  "message": "success",
  "data": {
    "docTemplateId": "template_123456789",
    "docTemplateCreateUrl": "https://app.esignglobal.com/template/create?token=example"
  }
}