Central do desenvolvedor

Criar vista de envio de envelope

POST /esignglobal/v1/envelopes/views/sender

Descrição da Interface

Cria uma vista de remetente de envelope através do ID do envelope. Os programadores podem integrar a vista de envio na sua própria aplicação de terceiros através da página obtida através desta interface.

  1. O processo de assinatura iniciado através da página de início de assinatura obtida através desta vista é preenchido com as informações do utilizador analisadas a partir do Access Token no oauth.
  2. Antes de chamar esta interface, é necessário criar um envelope com o estado de rascunho através da interface de criação do processo de assinatura.
  3. Após criar o ID do processo de assinatura, é permitido definir o envelope através de interfaces como adicionar ficheiros de assinatura e adicionar signatários.
  4. A página de início gerada por esta vista suporta a incorporação de iframe e webview, e o idioma da página é inglês por defeito.
  5. A chamada desta interface não suporta processos de assinatura que incluam a assinatura silenciosa do signatário.

Parâmetros de Pedido

Nome do Parâmetro

Tipo

Obrigatório

Descrição

envelopeId

string

true

ID do processo de assinatura, apenas é permitido introduzir o ID do processo de assinatura 0 - criado (rascunho)

returnUrl

string

true

Endereço de redirecionamento após a conclusão do envio do processo de assinatura (comprimento 2048), que deve estar em conformidade com o endereço do protocolo https/http

settingsobjectfalseDefinições personalizadas da página de envio
 startingPagestringfalseEnvia a página inicial da vista, por defeito preparePage.
preparePage - Página de configuração de informações básicas
taggingPage - Página de configuração de controlos de assinatura
 submitActionstringfalseSubmeter, por defeito send
save - Guardar, a página mostra o botão de guardar e esconde os botões relacionados com o envio;
send - Enviar, a página mostra os botões enviar agora, enviar e enviar mais tarde, e esconde o botão de guardar;
 showBackButtonbooleanfalseSe deve mostrar o botão Voltar na Página de Tagging, por defeito true.
true - Mostrar
false - Não mostrar
 

lockedArea

arrayfalse

Informações que não podem ser modificadas na senderView, por defeito vazio. Os valores de enumeração incluem:

document - Assinar documento

signerInfo - Informação do Signatário

Exemplo de Pedido

{
    "envelopeId":"75a12f86018040d58e4ba06d6bc9028d",
    "returnUrl":"ggg.fengli.com"
}

Parâmetros de Resposta

Nome do Parâmetro

Tipo

Descrição

url

string

Endereço da página de iniciação do envelope

Exemplo de Resposta

{
    "code": "0",
    "data": {
        "url": "https://app-test-as1.esignglobal-inc.com/document/refine-info?envelopeId=75a12f86018040d58e4ba06d6bc9028d&tcode=...&dc=as1"
    },
    "message": "success"
}

 

Descrição da Interface
Parâmetros de Pedido
Exemplo de Pedido
Parâmetros de Resposta
Exemplo de Resposta