eSign.AIeSign.AI
Central do desenvolvedor

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

POST /esignglobal/v1/templates/edit

Descrição da API

Os desenvolvedores podem obter o link da página de edição do modelo de arquivo especificado por meio desta API docTemplateEditUrl e abrir esse link para que o operador edite o modelo de arquivo existente na página.

Observações

  • docTemplateId é o ID do modelo de arquivo, que deve ser um modelo válido com permissão de acesso na conta do parceiro de integração atual.
  • Após a chamada bem-sucedida da API, será retornado docTemplateEditUrl , este link possui validade limitada; recomenda-se seu uso imediato após a obtenção, não sendo recomendado armazená-lo em cache por longos períodos.
  • Os desenvolvedores podem, por meio de redirectUrl especificar a página de redirecionamento após a conclusão da edição do modelo.

Parâmetros de requisição

Nome do parâmetro

Tipo

Obrigatório

Descrição

docTemplateId

string

true

ID do modelo de arquivo, que deve ser um modelo válido na conta do parceiro de integração atual.

redirectUrl

string

false

Link de redirecionamento após a conclusão da edição do modelo, deve ser um URL válido.

Exemplo de solicitação

{
  "docTemplateId": "template_123456789",
  "redirectUrl": "https://example.com/template/edit/callback"
}

Parâmetros de resposta

Nome do parâmetro

Tipo

Descrição

code

int

Código de status.

message

string

Informações de resposta.

data

object

Dados de resposta.

data.docTemplateEditUrl

string

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

Exemplo de resposta

{
  "code": 0,
  "message": "success",
  "data": {
    "docTemplateEditUrl": "https://app.esignglobal.com/template/edit?token=example"
  }
}