Protección de lectura de la solicitud de firma

Uso de validateCode

Última revisión: 20 feb 2023

Casos de uso básicos para probar la funcionalidad ValidateCode y ValidateCodeFinish y todas sus variantes. Se usan para proteger el acceso a la página de firma y para proteger la finalización del proceso respectivamente.

Se trata de un mecanismo introducido a nivel del objeto notification, válido para procesos simples (/messages) y procesos compuestos (/set). ValidateCode y ValidateCodeFinish se pueden configurar a nivel de API y a nivel de configuración de plantillas.

A partir de la v3.7.40 se introduce una nueva variante de uso, pudiendo establecer un validateCode basado en OTP SMS y en OTP Mail.

atributo	uso desde API	uso desde Plantilla	uso en signPage	uso en APP
validateCode	sí	sí	sí	sí
validateCodeFinish	sí	sí	sí	sí
validateCodeType	sí	sí	sí	no

El uso de validateCodeType basado en OTP requiere el uso de Viafirma SimpleSign-OTP, por lo que tu grupo o instalación privada debe contar con unas credenciales válidas para poder consumir este servicio.

Uso de la funcionalidad ValidateCode

Protege el acceso a la página de firma. Requiere el uso del siguiente atributo en el objeto notification.

"notification":{
   "validateCode":"string"
 }

Se trata de un código estático que el usuario firmante debe conocer para poder acceder.

Uso de la funcionalidad ValidateCodeFinish

Protege la finalización del proceso de firma una vez que todas las políticas han sido finalizadas. Requiere el uso del siguiente atributo en el objeto notification.

"notification":{
   "validateCodeFinish":"string"
 }

Se trata de un código estático que el usuario firmante debe conocer para poder finalizar.

Su uso está pensado para procesos de venta basados en kioskos de auto-venta, donde el usuario final completa por sí mismo la solicitud de firma, pero requiere de la presencia de un vendedor antes de finalizar.

Uso de la funcionalidad ValidateCodeType (OTP)

Protege el acceso a la página de firma mediante código OTP remitido por SMS o por Email, usando en cada caso las propiedades phone o mail del objeto recipient.

  "recipients": [
    {
      "key": "string",
      "phone": "string",
      "mail": "string"
    }
  ]

Para cada caso requiere el uso de los siguientes atributos en el objeto notification.

"notification":{
   "validateCodeType":"string",
   "validateOtpSubject" : "string",
   "validateOtpText" : "string"
 }

atributo	requerido	desc
validateCodeType	sí	valores admitidos: OTP_SMS y OTP_MAIL
validateSubject	no	solo válido para para OTP_MAIL. En caso de no usarlo se envía un asunto por defecto
validateText	no	Texto incluido en el SMS o en el body del email. En caso de no usarlo se envía un asunto por defecto

Ejemplo:

"notification":{
   "validateCodeType":"OTP_MAIL"
 }

Ejemplo de uso

{
"groupCode": "{{groupCode}}",
"title" :     "ValidateCode",
"description" : "04 - new with OTP SMS ValidateCode",
"recipients": [
    {
      "key": "signer01",
      "phone" : "{{recipientPhone}}",
      "presential" : true   
    }
  ],
  "messages" : [{
        "notification":{
            "validateCodeType":"OTP_SMS"
        },
        "document" : {
            "templateType": "url",
            "templateReference": "{{pdf_url_sample}}"
        },
        "policies" : [ {
            "signatures" : [ {
                "type" : "CLIENT",
                "recipientKey" : "signer01"
            } ]
        } ]
    }]
}

Postman Collection

En este enlace puedes descargar una colección postman con este caso de uso:

Documents API Validate Code

Editar un código de validación

A partir de la v3.7.62 dispones en el API de un método PUT para modificar el método de validación definido en tu proceso de firma.

URL del método: /messages/editValidation
Seguridad: sí, requiere autenticación. El API que consuma el servicio debe ser propietaria del proceso que desea ser modificado.
Método: PUT
ContentType/Application: application/json