Versions Compared

Old Version 6

changes.mady.by.user Editor

Saved on

compared with

New Version 7

changes.mady.by.user Editor

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

getSignedFinalDocHash

está obsoleta.

getVersion

gets the version of the obtiene la versión del PadConnector.

The reply contains La respuesta contiene "data" with con "ret" with the versioncon la versión.

keepAlive

Replies Responde "data" that contains a que contiene un "ret" with the text con el texto "ok".

onStaticAppletGetImage

is a lazy reply of

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

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

Code Block
{
"data":{
 	"value0":1,
	"value1":2,
	"messageId":"6d1a23df-5919-4d75-9446-4a6d95f4ed7a"
},
"type":"onStaticAppletGetImage"
}

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 La petición contiene «data» que contiene «buttonConfigs» que es un conjunto de configuraciones de botones, para cambiar los botones.

Respuestas"ok".

Code Block
{"data":{
"buttonConfigs":[{"mode":"DocView","visible":true,"color":-16711936,"kind":"StartSignature","enabled":true}],
"messageId":"3af72aa7-7d90-4f52-a159-edf4cafbb599"},
"type":"setButtonConfigs"}}
{"data":{"ret":"ok"},"messageId":"3af72aa7-7d90-4f52-a159-edf4cafbb599","type":"response"}

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

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.