Firma Embebida en una Aplicación de Terceros

Última revisión: 23 Marzo 2023

Para embeber la lógica de firma en un tu sistema sólo debes definir la propiedad "presential" : true en la configuración del firmante. Con ello, el API de Viafirma NO notificará al firmante, y en su lugar obtendrás el link asociado al firmante desde el que podrá acceder a la página de firma.

En tu SET podrás tener firmantes con la propiedad presential a true y otros a false, obteniendo el link de la página de firma únicamente de los firmantes cuya propiedad presential valga true.

Debes saber:

• la propiedad presential es opcional, y su valor por defecto es false.
• los firmantes (recipients) para firma presencial NO recibirán notificaciones por parte de Viafirma (notificación de nueva solicitud).
• las notificaciones de callback (cuando finaliza el proceso) no tienen relación con el tipo de firma presencial, es decir, si el firmante (recipient) tiene informado un email, y la configuración de callbackMails está informada, el firmante recibirá notificación por parte de Viafirma, con independencia de que este firmante participara en la firma de forma presencial o remota.

Ejemplos

Ejemplo SET con 2 firmantes para firma embebida:

"recipients": [
    {
      "key": "signer01",
      "mail": "[email protected]",
      "name": "Firmante 1",
      "presential" : true
    },{
      "key": "signer02",
      "mail": "[email protected]",
      "name": "Firmante 2",
      "presential" : true
    }
  ]

Respuesta:

{
    "code": "LL621679514158594T631",
    "status": "RECEIVED",
    "links": [
        {
            "key": "signer01",
            "link": "https://sandbox.viafirma.com/sign-page/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ...",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2ZXIiOi..."
        },
        {
            "key": "signer02",
            "link": "https://sandbox.viafirma.com/sign-page/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZX...",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2ZXIiOiJodHRwczovL3NhbmRib3..."
        }
    ],
    "messages": [
        {
            "code": "LL621679514158601R318",
            "status": "WAITING",
            "policies": [
                {
                    "evidences": [
                        {
                            "type": "SIGNATURE",
                            "id": "1679514160711",
                            "enabled": true,
                            "visible": true,
                            "code": "LL621679514158601R318P001E001",
                            "status": "PENDING",
                            "helpText": "Firma de Juan Test",
                            "helpDetail": "Firmado por Juan Test",
                            "imageText": "Firmado por Juan Test",
                            "recipientKey": "firmante1",
                            "imageTextLocation": "DOWN",
                            "imageTextSize": 10
                        }
                    ],
                    "signatures": [
                        {
                            "type": "SERVER",
                            "code": "LL621679514158601R318P001S001",
                            "status": "PENDING",
                            "lastUpdated": 0
                        }
                    ]
                }
            ]
        }
    ]
}

Ejemplo SET con 2 firmantes, uno de ellos para firma embebida

"recipients": [
    {
      "key": "signer01",
      "mail": "[email protected]",
      "name": "Firmante 1",
      "presential" : false
    },{
      "key": "signer02",
      "mail": "[email protected]",
      "name": "Firmante 2",
      "presential" : true
    }
  ]

Para el ejemplo anterior obtendrás unicamente un link de firma, el que corresponde al firmante 2 cuya propiedad presential vale true.

{
    "code": "LL621679514002999T629",
    "status": "RECEIVED",
    "links": [
        {
            "key": "signer01",
            "link": "https://sandbox.viafirma.com/sign-page/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzZXJ2ZXIiOiJodHRwczovL...",
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzxE..."
        }
    ],
    "messages": [
        {
            "code": "LL621679514003007R569",
            "status": "WAITING",
            "policies": [
                {
                    "evidences": [
                        {
                            "type": "SIGNATURE",
                            "id": "1679514005504",
                            "enabled": true,
                            "visible": true,
                            "code": "LL621679514003007R569P001E001",
                            "status": "PENDING",
                            "helpText": "Firma de Juan Test",
                            "helpDetail": "Firmado por Juan Test",
                            "imageText": "Firmado por Juan Test",
                            "recipientKey": "firmante1",
                            "imageTextLocation": "DOWN",
                            "imageTextSize": 10
                        }
                    ],
                    "signatures": [
                        {
                            "type": "SERVER",
                            "code": "LL621679514003007R569P001S001",
                            "status": "PENDING",
                            "lastUpdated": 0
                        }
                    ]
                }
            ]
        }
    ]
}