eSign.AIeSign.AI
Central do desenvolvedor

Obter o link da página de criação de modelo de arquivo

POST /esignglobal/v1/templates/create

Descrição da interface

Obtenha o link para a página de criação de modelos de arquivo.

Os desenvolvedores podem obter um link com validade temporária para a página de criação de modelos de arquivo através desta interface docTemplateCreateUrl e abrir esse link para que o usuário crie um modelo de arquivo na página com base no arquivo especificado.

Observações

  • fileKey é a KEY do arquivo obtida por meio da interface de upload, usada para especificar o arquivo base para a criação deste modelo.
  • docTemplateType padrão é 0, indicando modelo PDF; ao informar 2 indica modelo HTML, adequado para cenários de adição dinâmica de linhas de tabela e preenchimento de conteúdo.
  • Após a chamada bem-sucedida da interface, retorna docTemplateCreateUrl, este link possui validade limitada. Recomenda-se utilizá-lo imediatamente após a obtenção; não é recomendado mantê-lo em cache por longos períodos.
  • Os desenvolvedores podem utilizar redirectUrl para especificar a página de redirecionamento após a conclusão da criação do modelo.

Parâmetros de requisição

Nome do parâmetro

Tipo

Obrigatório

Descrição

docTemplateName

string

true

Nome do modelo de arquivo, pode ser personalizado.

fileKey

string

true

KEY do arquivo, obtido por meio da interface de upload de arquivos.

docTemplateType

int

false

Tipo de modelo de arquivo, o valor padrão é 0

0: Modelo PDF.

2: Modelo HTML, adequado para cenários em que linhas de tabela são adicionadas dinamicamente e preenchidas com conteúdo.

redirectUrl

string

false

Link de redirecionamento após a conclusão da criação do modelo, deve ser uma URL válida.

Exemplo de solicitação

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

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

code

int

Código de status.

message

string

Informação de resposta.

data

object

Dados de resposta.

 

docTemplateId

string

ID do modelo de arquivo criado.

 

docTemplateCreateUrl

string

Link para a página de criação do modelo de arquivo, com validade temporária.

Exemplo de resposta

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