Versions Compared

Key

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

...

Table of Contents
minLevel3
maxLevel3

...

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 valuevalue.

  • 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.

Code Block
{"data":{"messageId":"ceec4053-a1f3-4a6f-996d-a4b3e975cd83"},"type":"getButtonConfigs"}

{"data":{"ret":[
{"mode":"Signature", "visible":true, "color":-16776961, "kind":"Rotate", "enabled":true}, 
{"mode":"Signature", "visible":false, "color":-16776961, "kind":"Rotate90", "enabled":false}, 
{"mode":"Signature", "visible":false, "color":-16711936, "kind":"Next", "enabled":false}, 
{"mode":"Signature", "visible":false, "color":-16711936, "kind":"Prev", "enabled":false}, 
{"mode":"Signature", "visible":true, "color":-16711936, "kind":"Ok", "enabled":true}, 
{"mode":"Signature", "visible":true, "color":-8372224, "kind":"Repeat", "enabled":true}, 
{"mode":"Signature", "visible":true, "color":-16711936, "kind":"Cancel", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-16776961, "kind":"Rotate", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-16776961, "kind":"Rotate90", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-65536, "kind":"Next", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-16776961, "kind":"Prev", "enabled":false}, 
{"mode":"DocView", "visible":true, "color":-16776961, "kind":"ZoomIn", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-16776961, "kind":"ZoomOut", "enabled":true}, 
{"mode":"DocView", "visible":true, "color":-65536, "kind":"StartSignature", "enabled":true}, 
{"mode":"DocSign", "visible":true, "color":-16776961, "kind":"Rotate", "enabled":true}, 
{"mode":"DocSign", "visible":false, "color":-16776961, "kind":"Rotate90", "enabled":false}, 
{"mode":"DocSign", "visible":true, "color":-14336, "kind":"Next", "enabled":true}, 
{"mode":"DocSign", "visible":true, "color":-16725761, "kind":"Prev", "enabled":true}, 
{"mode":"DocSign", "visible":true, "color":-16740298, "kind":"Ok", "enabled":true}, 
{"mode":"DocSign", "visible":true, "color":-996296, "kind":"Repeat", "enabled":true}, 
{"mode":"DocSign", "visible":true, "color":-1966054, "kind":"Cancel", "enabled":true}]}, 
"messageId":"ceec4053-a1f3-4a6f-996d-a4b3e975cd83","type":"response"}

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.

Code Block
{"data":{"messageId":"13dad597-d82c-44ac-9f6d-0906ce95f775"},"type":"getButtonEvents"}{ "data":{"ret":{"kind":"StartSignature"}}," messageId":"13dad597-d82c-44ac-9f6d-0906ce95f775","type":"response" }

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.

Code Block
deviceType=duraSign 10.0,
serial=123456000,
openState=3,
cryptoIdInfo=<?xml version="1.0" encoding="UTF-8"?><CryptoIDInfoList xmlns="http://www.stepover.com/CryptoIDContaineInfoXMLSchema">
	<CryptoIDInfo><id>0</id><description>StepOver cryptoIdv1</description><padCertLength>256</padCertLength><padNotaryLength>256</padNotaryLength></CryptoIDInfo>
	<CryptoIDInfo><id>1</id><description>StepOver cryptoIdv2</description><padCertLength>512</padCertLength><padNotaryLength>256</padNotaryLength></CryptoIDInfo>
	<CryptoIDInfo><id>2</id><description>StepOver cryptoIdv2</description><padCertLength>512</padCertLength><padNotaryLength>512</padNotaryLength></CryptoIDInfo>
</CryptoIDInfoList>,
cryptoIdInfoJson=[
	{"padCertLength":256,"description":"StepOver cryptoIdv1","padNotaryLength":256},
	{"padCertLength":512,"description":"StepOver cryptoIdv2","padNotaryLength":256},
	{"padCertLength":512,"description":"StepOver cryptoIdv2","padNotaryLength":512}
],
firmwareVersion=7.9.0.354,
deviceTime=1644853028000

...