Centro de desarrolladores

Crear vista de envío de sobre

POST /esignglobal/v1/envelopes/views/sender

Descripción de la interfaz

Crea una vista de remitente de sobre a través de la ID del sobre. Los desarrolladores pueden integrar la vista de envío en su propia aplicación de terceros a través de la página obtenida por esta interfaz.

  1. El proceso de firma iniciado a través de la página de inicio de firma obtenida a través de esta vista, el iniciador se completa con la información del usuario analizada en el token de acceso en oauth
  2. Antes de llamar a esta interfaz, debe crear un sobre en estado de borrador a través de la interfaz de creación del proceso de firma
  3. Después de crear la ID del proceso de firma, puede configurar el sobre a través de interfaces como agregar archivos de firma y agregar firmantes.
  4. La página de inicio generada por esta vista admite la incrustación de iframe y webview, y el idioma de la página es inglés de forma predeterminada.
  5. La llamada a esta interfaz no admite procesos de firma que incluyan la firma silenciosa del firmante.

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

envelopeId

string

true

ID del proceso de firma, solo se permite ingresar la ID del proceso de firma 0-creado (borrador)

returnUrl

string

true

Dirección de redireccionamiento después de que se complete el envío del proceso de firma (longitud 2048), debe cumplir con la dirección del protocolo https /http

settingsobjectfalseConfiguración personalizada de la página de envío
 startingPagestringfalseEnviar la página de inicio de la vista, preparePage por defecto.
preparePage - Página de configuración de información básica
taggingPage - Página de configuración de control de firma
 submitActionstringfalseEnviar, send por defecto
save - Guardar, la página muestra el botón de guardar y oculta los botones relacionados con send;
send - Enviar, la página muestra los botones de enviar ahora, enviar y enviar más tarde, y oculta el botón de guardar;
 showBackButtonbooleanfalse¿Mostrar el botón Atrás de la página de etiquetado? True por defecto.
true - Mostrar
false - No mostrar
 

lockedArea

arrayfalse

Información que no se puede modificar en senderView, el valor predeterminado es vacío. Los valores de enumeración incluyen:

document - Firmar documento

signerInfo - Información del firmante

Ejemplo de solicitud

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

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

url

string

Dirección de la página para iniciar el sobre

Ejemplo de respuesta

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

 

Descripción de la interfaz
Parámetros de solicitud
Ejemplo de solicitud
Parámetros de respuesta
Ejemplo de respuesta