Uso de validateCode

Última revisión: 4 oct 2022

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
validateCodeFinish
validateCodeType 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 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"
            } ]
        } ]
    }]
}

En el siguiente enlace puedes descargar una colección postman con varios casos de uso con esta funcionalidad.

validateCode Postman Collection

results matching ""

    No results matching ""