Centro de desarrolladores

Obtener detalles del control de plantilla del firmante

GET/esignglobal/v1/templates/signerFieldsDetail

Descripción de la interfaz

Consulta la información del control del firmante en la plantilla.

A través del número de plantilla de contratotemplateIdpara obtener la información del control del firmante configurada en la plantilla, y luego a través deIniciar rápidamente el sobreinterfaz para iniciar el sobre.

 

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

templateId

string

true

ID de la plantilla de contrato, se puede consultar en la gestión de plantillas de SaaS  

Ejemplo de solicitud

GET  https:// … …/esignglobal/v1/templates/signerFieldsDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

 

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

templateId

string

ID de la plantilla de contrato

templateName

string

Nombre de la plantilla de contrato

signerFields

array

Información de la lista de controles de firmantes en la plantilla

 

signConfigs

array

Información del control de firma

 

 

fieldId

string

ID del control (generado automáticamente por eleSignGlobalsistema al configurar la plantilla de contrato)

 

 

fieldKey

string

Clave del control (definida por el usuario al configurar la plantilla de contrato)

 

 

fieldType

string

Tipo de control:

signature-Área de firma

stamp-Área de sello

approval-Control de aprobación

 

 

sizeRule

string

Forma de visualización del tamaño del área de firma

originalSize-Sellar según el tamaño real de la firma/sello

targetSize-Ancho y alto personalizados del área de firma/sello

 

 

height

int

Altura del control de firma

 

 

width

int

Ancho del control de firma

 

 

movable

boolean

Permitir mover la posición al firmar

false-No permitir que el firmante ajuste la posición de su propio control de firma

true-Permitir que el firmante ajuste la posición de su propio control de firma

 

 

allowedOptions

array

Opciones permitidas para que el firmante apruebe, aplicable cuando fieldType es approval. El valor predeterminado es ["approve", "decline"]

approve-Aprobar

decline-Rechazar

 

 

posX

float

Coordenada X de la posición del control

 

 

posY

float

Posición del controlYCoordenada Y

 

 

pageNo

string

Número de página donde se encuentra el control

 

fillConfigs

array

Información del control de firma

 

 

fieldId

string

ID del control (generado automáticamente por eleSignGlobalsistema al configurar la plantilla del contrato)

 

 

fieldKey

string

Clave del control (definida por el usuario al configurar la plantilla de contrato)

 

 

fieldName

string

Nombre del control

 

 

required

boolean

¿Es obligatorio?

true-Obligatorio

false-No obligatorio

 

 

fieldsType

string

Tipo de control:

1-Texto de una sola línea

15-Casilla de verificación

 

 

textField

object

Propiedades del control de texto

 

 

 

overflowType

int

Solo aplica al texto

1-Reducir automáticamente el tamaño de la fuente

2-Restringir la entrada

 

 

 

minFontSize

float

Solo aplica al texto, solo aplica a overflowType=1.

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

width

float

Ancho del control

 

 

 

fontSize

float

Solo aplica al texto, tamaño de fuente

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

textColor

string

Solo aplica al texto, color hexadecimal

 

 

 

bold

boolean

Solo aplica al texto, ¿la fuente está en negrita?

true-Negrita

false-Sin negrita

 

 

 

italic

boolean

Solo aplica al texto, ¿cursiva?

true-Cursiva

false-Sin cursiva

 

 

 

underline

boolean

Solo aplica al texto, ¿subrayado?

true-Subrayado

false-Sin subrayado

 

 

 

lineThrough

boolean

Solo aplica a texto, ¿agregar línea de tachado?

true-Agregar línea de tachado

false-No agregar línea de tachado

 

 

 

horizontalAlignment

string

Solo aplica a texto, formato de centrado horizontal

LEFT-A la izquierda

CENTER-Centrado

RIGHT-A la derecha

 

 

tickBoxField

object

Propiedades de la casilla de verificación

 

 

 

tickOptions

array

Solo aplica a Check

1-Palomita

2-Cruz

 

 

posX

float

Coordenada X horizontal de la posición del control

 

 

posY

float

Posición del controlYCoordenada vertical

 

 

pageNo

string

Número de página donde se encuentra el control

 

signDateConfigs

array

Información de la fecha de firma

 

 

fieldId

string

ID del control (generado automáticamente por eleSignGlobalsistema al configurar la plantilla del contrato)

 

 

fieldKey

string

Clave del control (definida por el usuario al configurar la plantilla del contrato)

 

 

movable

boolean

Permitir mover la posición al firmar

false-No permitir que el firmante ajuste la posición de su propio control de firma

true-Permitir que el firmante ajuste la posición de su propio control de firma

 

 

posX

float

Coordenada X horizontal de la posición del control

 

 

posY

float

Posición del controlYCoordenada vertical

 

 

pageNo

string

Número de página donde se encuentra el control

 

 

signDateFormat

string

Formato de fecha de firma

Ejemplo de respuesta

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}

 

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