The PadConnector assumes that requests over the web socket are JSON objects.
The requests contain a "messageId" field.
The requests contain a "type" field.
The requests may contain a "data" field whose structure varies for different message types.
Replies are JSON objects.
Replies may contain a "messageId" field.
Replies may contain a "data" field.
The messageId may be a field of the "data" field.
Lazy replies are replies that may be sent in the future.
Lazy replies contain a "type" field.
Lazy replies contain a "data" field that has a "messageId" field and a sequence of fields with keys "valueEl PadConnector asume que las peticiones a través del socket web son objetos JSON. .
Las peticiones contienen un campo "messageId".
Las peticiones contienen un campo "type".
Las peticiones pueden contener un campo "data" cuya estructura varía para los diferentes tipos de mensajes..
Las respuestas son objetos JSON.
Las respuestas pueden contener un campo "messageId"..
Las respuestas pueden contener un campo "data”.
El messageId puede ser un campo del campo "data”.
Las respuestas estáticas son respuestas que pueden enviarse en el futuro.
Las respuestas estáticas contienen un campo "type”.
Las respuestas estáticas contienen un campo «data» que tiene un campo «messageId» y una secuencia de campos con claves «value[0-9]+».".
...
Tipos
| Table of Contents | ||||
|---|---|---|---|---|
|
...
Peticiones,
...
respuestas,
...
respuestas estáticas.
executeDeviceSearch
searches devices and selects one of them.
The reply contains busca dispositivos y selecciona uno de ellos.
La respuesta contiene"data" with con "ret" with a onecon un uno (1) in case of successen caso de que la respuesta sea afirmativa.
finishSigning
ends a running signature capture in a similar way as the OK click on the device.
This should lead to a lazy "onStaticAppletSignatureFinished" replyfinaliza una captura de firma en ejecución de forma similar al clic de OK en el dispositivo.
Esto debería dar lugar a una respuesta estática «onStaticAppletSignatureFinished».
getBioData
gets biodata.
The reply contains "data" that contains a "ret" field with the biodata as a base64-encoded sequence of naturaSignV2 records.
getButtonConfigs
gets the current button configuration of the signature pad. Since v2.2.0
The reply contais "data" with "ret" with an array of button configs.
An element of that array, a single button config, has the fieldsobtiene biodatos.
La respuesta contiene «data» que contiene un campo «ret» con los biodatos como una secuencia codificada en base64 de registros naturaSignV2.
getButtonConfigs
obtiene la configuración actual de los botones de la tableta de firma. Desde v2.2.0
La respuesta contiene «data» con «ret» con un conjunto de configuraciones de botones.
Un elemento de esa matriz, una sola configuración de botón, tiene los campos
mode being one of Signature or DocView or DocSign
kind being one of Ok, Repeat, Cancel, Rotate, Rotate90, Prev, Next, ZoomIn, ZoomOut, StartSignature
visible, boolean
enabled, boolean
color which is a 32bit ARGB value.
...
el modo puede ser Firma, DocView o DocSign
siendo uno de: Ok, Repeat, Cancel, Rotate, Rotate90, Prev, Next, ZoomIn, ZoomOut, StartSignature
visible, booleano
enabled, booleano
color, que es un valor Valor ARGB de 32 bits.
|
|
|
getButtonEvents
observes the button clicks on the pad. Since observa las pulsaciones de botón en Tableta de firma. Desde la v2.2.0The lazy replies contain "data" that contains "ret" that contains the "kind" of the button which was clicked
Las respuestas estáticas contienen «data» que contiene «ret» que contiene el «kind» del botón que se ha pulsado.
|
getDevice
gets the name of the selected device
The reply contains obtiene el nombre del dispositivo seleccionado
La respuesta contiene "data" with con "ret" with the namecon el nombre.
getDeviceCertificate
gets a certificate which is necessary to verify the last signature.
The reply contains obtiene un certificado necesario para verificar la última firma.
La respuesta contiene "data" with con "ret" with a base64 encoded DER encoded con un certificado X.509 certificatecodificado DER en base64.
getDeviceCount
gets the number of attached signature devices
reply contains obtiene el número de dispositivos de firma conectados
reply contiene "data" with con "ret" with the number of devicescon el número de dispositivos.
getDeviceInfo
gets information on the selected device.
The reply contains obtiene información sobre el dispositivo seleccionado.
La respuesta contiene "data" with con "ret" withcon
"serial", the serial number,
"deviceType", the device type,
"firmwareVersion", the firmware version,
"openState", the open state, it should be zeroserial», el número de serie,
«deviceType», el tipo de dispositivo,
«firmwareVersion», la versión del firmware,
«openState», el estado abierto, debe ser cero(0),
"deviceTime", the time as milliseconds since «deviceTime», el tiempo en milisegundos desde 1970,
"cryptoIdInfo", an XML text containing info about the cryptographic keys stored on the device.
"cryptoIdInfoJson", contains similar information as "cryptoIdInfo" as a JSON array. Since «cryptoIdInfo», un texto XML que contiene información sobre las claves criptográficas almacenadas en el dispositivo.
«cryptoIdInfoJson», contiene información similar a “cryptoIdInfo” en forma de matriz JSON. Desde v2.1.0.
|
getDeviceOpened
gets whether the device has been opened.
The reply contains obtiene si el dispositivo ha sido abierto.
La respuesta contiene "data" with con "ret" with con "true" or o "false".
getDeviceSerial
Replies Responde "data" that contains a que contiene un "ret" with the device serial number
getEncryptedAesKey
gets a key that is necessary for decrypting the bioData captured during in the last signature processcon el número de serie del dispositivo
getEncryptedAesKey
obtiene una clave necesaria para descifrar los bioDatos capturados durante el último proceso de firma.
request
"data" contains a contiene un campo "darray" field which is a JSON array of numbers each being an octet of the preliminary document hashque es una matriz JSON de números, cada uno de los cuales es un octeto del hash del documento preliminar.
reply
"data" that contains a que contiene un campo "ret" field with the base64-encoded encrypted AES keycon la clave AES cifrada con codificación base64
getNotaryInfo
Replies Responde "data" that contains a que contiene un "ret" with the notary infocon la información notarial.
getPreliminaryData
gets preliminary data including the last signature imageobtiene los datos preliminares, incluida la última imagen de firma.
request
"data" that contains
...
"withAlpha", whether to use an alpha channel for transparency,
...
"width" the desired width of the image,
...
que contiene
«withAlpha», si utilizar un canal alfa para la transparencia,
«width» la anchura deseada de la imagen,
«height» la altura deseada de la imagen.
reply
contains contiene "data" with con "ret" which contains an array with these items
the bio data,
the certificate necessary to verify the signature as baset64 text,
the last signature image as base64 text,
the notary information as base64 text,
the device name,
the device serial number.
getSignatureImage
gets the signature image in one of two ways.
If startSigning has been called with the "config" map,
this responds a stream of images that ends when the signature ends.
que contiene un array con estos elementos
los datos biométricos
el certificado necesario para verificar la firma como texto base64,
la última imagen de la firma como texto base64,
la información del notario como texto base64,
el nombre del dispositivo,
el número de serie del dispositivo.
getSignatureImage
obtiene la imagen de la firma de dos maneras.
Si se ha llamado a startSigning con el mapa "config",
esto responde a un flujo de imágenes que termina cuando finaliza la firma.Else, it sends a single image.
"data" may contain
"withAlpha", whether to use an alpha channel for transparency, (true or false),
"width" the desired width,
"height" the desired height.
getSignedFinalDocHash
is obsolete.
getVersion
gets the version of the PadConnector.
The reply contains "data" with "ret" with the version.
keepAlive
Replies "data" that contains a "ret" with the text puede contener
«withAlpha», si utilizar un canal alfa para la transparencia, (verdadero o falso),
«width» la anchura deseada,
«height» la altura deseada.
getSignedFinalDocHash
está obsoleta.
getVersion
obtiene la versión del PadConnector.
La respuesta contiene "data" con "ret" con la versión.
keepAlive
Responde "data" que contiene un "ret" con el texto "ok".
onStaticAppletGetImage
is a lazy reply of
a startSigning or a
a startViewing request.
It either is a signal (1) or a request for an image (2).
How to react to the signal depends on the applicationes una respuesta estática de
un startSigning a una
una solicitud startViewing
Puede ser una señal (1) o una solicitud de imagen (2).
Cómo reaccionar ante la señal depende de la aplicación.
"data" containscontiene
value0, the one-based page number
value1, is either one (1) or two (2)
In case of an image request as a consequence of a startSigning request,
render the page with the resolution used in that request
and send it as part of the reply to the PadConnector.
Note that zero-based page numbers are used in the startSigning request.
...
valor0, el número de página basado en uno
valor1, es uno (1) o dos (2)
En caso de una petición de imagen como consecuencia de una petición startSigning
renderiza la página con la resolución utilizada en dicha solicitud
y enviarla como parte de la respuesta al PadConnector.
Tenga en cuenta que en la solicitud startSigning se utilizan números de página basados en cero.
Ejemplo
|
setButtonConfigs
sets the button configuation. Since establece la configuración de los botones. Desde la v2.2.0.
The request contains "data" that contains "buttonConfigs" which is an array of button configs , to change the buttons.
Replies "ok".
...
La petición contiene «data» que contiene «buttonConfigs» que es un conjunto de configuraciones de botones, para cambiar los botones.
Respuestas"ok".
|
setFinalDocHash
sets the final document hash to be signed.
establece el hash final del documento que se va a firmar.request
"data" contains a contiene un campo "darray" field which is a JSON array of numbers each being an octet of the final document hashque es una matriz JSON de números, cada uno de los cuales es un octeto del hash final del documento.
reply
"datadatos" contains a contiene un "ret" with the text con el texto "ok".
lazy reply
"type" is "onStaticAppletSignedFinalDocHash" contains "data" with "value0" field
that is a JSON array of numbers each being an octet of an RSA signature.
start
resets state and replies ok.
The lazy reply "onStaticAppletLoaded" is sent when the operation completed.
startSigning
starts a signing process«type» es “onStaticAppletSignedFinalDocHash” contiene “data” con el campo »value0»
que es una matriz JSON de números, cada uno de los cuales es un octeto de una firma RSA.
start
restablece el estado y responde ok.
La respuesta estática «onStaticAppletLoaded» se envía cuando se completa la operación.
startSigning
inicia un proceso de firma.
request
"data" should containdebe contener
"page", the page of the signature field,
"x", "y", "width", "height", the position of the signature field in inch/72
where"y" is the upper border from top
"x" is the left border from left
"resolution" tells with how many dots per inch the page will be rendered
and sent as a reply to "onStaticAppletGetImage".
"data" may contain
"withHashDialog" to change whether to sign the final doc hash with the hash dialog on the pad,
"signatureTimeout" to change the signature timeout in ms, the special value zero(0) means infinite.
"data" may contain "config" that may contain
the "cryptoId" to use with the selected pad
"signatureImageIntervalMillis" to change the interval of the image stream,
"signMode" which can be
"inDoc"
"standard",
"afterSignMode" which can be
"noModeChange",
"documentViewing",
"customerLogo"
"textLines" that contains a sequence of key value pairs,
the keys being [0-9]+, the values being lines of text to be displayed on the pad;"buttonConfigs", since v2.2.0, an array of button configs, to change the buttons«page», la página del campo de firma,
«x», “y”, “width”, “height”, la posición del campo de firma en pulgadas/72
donde«y» es el borde superior desde arriba
«x» es el borde izquierdo desde la izquierda
«resolution» indica con cuántos puntos por pulgada se mostrará la página
y se envía como respuesta a «onStaticAppletGetImage».
"data" may contain
"withHashDialog" to change whether to sign the final doc hash with the hash dialog on the pad,
"signatureTimeout" to change the signature timeout in ms, the special value zero(0) means infinite.
"data" puede contener "config" que puede contener
el «cryptoId» a utilizar con el pad seleccionado
«signatureImageIntervalMillis» para cambiar el intervalo del flujo de imágenes,
«signMode» que puede ser
«inDoc»
«standard»,
«afterSignMode» que puede ser
«noModeChange» que puede ser
«documentViewing»,
«customerLogo»
«textLines» que contiene una secuencia de pares clave-valor,
las claves son [0-9]+, los valores son líneas de texto que se mostrarán en la almohadilla;«buttonConfigs», desde la versión 2.2.0, una matriz de configuraciones de botones, para cambiar los botones.
reply
"data" contains a contiene un "ret" with the text con el texto "ok".
Lazy replies
"onStaticAppletCaptureStarted", is sent when the signer starts to sign.
"onStaticAppletGetImage" is sent when the PadConnector requires an image.
"onStaticAppletSignatureRepeat" is sent when the signature shall be repeated.
"onStaticAppletSignatureFinished" when the signature is finished either by
a "finishSigning" message by the client, or
an "OK" click on the signature pad, or
a timeout after the signer has stopped drawing.
"onStaticAppletSignatureCancel" is sent when the signature has been canceled by a click on the Cancel button on the pad.
"onStaticAppletError" is sent in case of error. If the pad has been disconnected, it contains "data" with "value0" "DISCONNECT".
Remarks
With color pads, this uses the sign-in-document mode, if
the "config" field is not used and "startViewing" has been called before or
the "config" field is used with "signMode" being "inDoc".
The standard sign mode will be used, if "start" or "stopSigning" have been called before.
Before answering the "setFinalDocHash" request with the lazy "onStaticAppletSignedFinalDocHash" reply,
the PC may switch the pad to another mode an "afteSignMode" was given.
If "config" was absent, the PC switches the pad to the customerLogo mode.
startViewing
starts a document viewing process. Supported devices can display document pages.
request
"data" may contain
...
"pages" with a number being the number of pages.
...
Respuestas estáticas
«onStaticAppletCaptureStarted», se envía cuando el firmante comienza a firmar.
«onStaticAppletGetImage», se envía cuando el PadConnector requiere una imagen.
«onStaticAppletSignatureRepeat», se envía cuando se debe repetir la firma.
«onStaticAppletSignatureFinished» cuando la firma ha finalizado, ya sea mediante
un mensaje «finishSigning» del cliente, o
un clic en «OK» en la tableta de firma, o
un tiempo de espera después de que el firmante haya dejado de dibujar.
«onStaticAppletSignatureCancel» se envía cuando se ha cancelado la firma haciendo clic en el botón Cancelar del pad.
«onStaticAppletError» se envía en caso de error. Si el pad se ha desconectado, contiene «data» con «value0» «DISCONNECT».
Observaciones
Con Tabletas de firma de color, esto utiliza el modo de inicio de sesión en el documento, si
no se utiliza el campo «config» y se ha llamado antes a «startViewing» o
el campo «config» se utiliza con «signMode» siendo «inDoc».
Se utilizará el modo de firma estándar si antes se ha llamado a «start» o «stopSigning».
Antes de responder a la petición «setFinalDocHash» con la respuesta «onStaticAppletSignedFinalDocHash»,
el PC puede cambiar el pad a otro modo si se ha dado «afteSignMode».
Si «config» estaba ausente, el PC cambia el pad al modo customerLogo.
startViewing
inicia un proceso de visualización de documentos. Los dispositivos compatibles pueden mostrar páginas de documentos.
request
"data" puede contener
«pages» con un número que es el número de páginas.
«buttonConfigs», desde v2.2.0, una matriz de configuraciones de botones, para cambiar los botones.
reply
"Ok".
lazy reply
"onStaticAppletGetImage" is sent when the PadConnector requires an imagese envía cuando el PadConnector requiere una imagen.
stopSigning
stops a signing process.
"data" may contain "showManufacturerLogo", a boolean that tells whether the pad should switch to manufacturer logo mode, also known as customer logo mode, also known as standby modedetiene un proceso de firma.
«data» puede contener “showManufacturerLogo”, un booleano que indica si el pad debe cambiar al modo de logotipo del fabricante, también conocido como modo de logotipo del cliente, también conocido como modo de espera.