Extender plazo de firma de un SET caducado

Última revisión: 10 Diciembre 2024

Un SET estado EXPIRED no permite ser firmado pero podrás ampliar su plazo a través del método extendSignaturePeriod.

Method: PUT
Content-Type: application/json
Service: /api/v3/set/extendSignaturePeriod

{
"setCode": (required) "String",
"expires": (required) timestamp milliseconds
"customization": {
        "mailFrom": (optional) "String",
        "smsFrom": (optional) "String",
        "requestMailSubject": (optional) "String",
        "requestMailBody": (optional) "String",
        "requestSmsBody": (optional) "String",
        "callbackSmsBody": (optional) "String",
        "callbackMailSuccessSubject": (optional)"String",
        "callbackMailSuccessBody": (optional) "String",
        "callbackMailExpiredSubject": (optional) "String",
        "callbackMailExpiredBody": (optional) "String",
        "callbackMailWaitingCheckSubject": (optional) "String",
        "callbackMailWaitingCheckBody": (optional) "String",
        "callbackMailRejectedSubject": (optional) "String",
        "callbackMailRejectedBody": (optional) "String",
        "callbackMailErrorSubject": (optional) "String",
        "callbackMailErrorBody": (optional) "String",
        "callbackSmsReminderBody": (optional) "String",
        "callbackMailReminderBody": (optional) "String",
        "callbackMailReminderSubject": (optional) "String",
        "successMessage": (optional) "String",
        "batchRequestSubject": (optional) "String",
        "batchRequestBody": (optional) "String",
        "creationNotificationSubject": (optional) "String",
        "creationNotificationBody": (optional) "String"
}

Ejemplo:

{
"setCode": "AAAA9999999999999R999",
"expires": 1652897955000,
"customization" : {
    "requestMailSubject" : "Tienes una solicitud de firma a través de Viafirma",
    "requestMailBody" : "<h3>Has recibido una solicitud de firma</h3>\n    <p>Hola {{recipient.name}},</p>\n    <p>Tienes <b>una solicitud pendiente de firmar</b> con Viafirma. Revísala y firma a través del botón que encontrarás abajo.</p>",
    "requestSmsBody" : "A través del siguiente enlace podrás acceder a los documentos que debes revisar y firmar electrónicamente:",
    "callbackSmsBody" : "El estado de la solicitud [MESSAGE_CODE] en Documents es [STATUS].",
    "callbackMailSuccessSubject" : "El documento {{TITLE}} ha finalizado correctamente",
    "callbackMailSuccessBody" : "<p>Mensaje de prueba por defecto en los estilos del grupo</p>",
    "callbackMailExpiredSubject" : "Viafirma documents [SANDBOX]: proceso [MESSAGE_CODE] [STATUS]",
    "callbackMailExpiredBody" : "<p>A continuación te mostramos el detalle del proceso de firma.</p><ul><li><strong>Estado del proceso</strong>: [STATUS]</li><li><strong>Título del proceso</strong>: [TITLE]</li><li><strong>Ref. del proceso</strong>: [MESSAGE_CODE]</li></ul><p>Si tienes alguna consulta recuerda usar el siguiente número de referencia: [MESSAGE_CODE] </p><p><br></p><p>Atentamente,</p><p>El equipo de viafirma documents.</p>",
    "callbackMailWaitingCheckSubject" : "Viafirma documents [SANDBOX]: proceso [MESSAGE_CODE] [STATUS]",
    "callbackMailWaitingCheckBody" : "<p>A continuación te mostramos el detalle del proceso de firma.</p><ul><li><strong>Estado del proceso</strong>: [STATUS]</li><li><strong>Título del proceso</strong>: [TITLE]</li><li><strong>Ref. del proceso</strong>: [MESSAGE_CODE]</li></ul><p>Si tienes alguna consulta recuerda usar el siguiente número de referencia: [MESSAGE_CODE] </p><p><br></p><p>Atentamente,</p><p>El equipo de viafirma documents.</p>",
    "callbackMailRejectedSubject" : "Viafirma documents [SANDBOX]: proceso [MESSAGE_CODE] [STATUS]",
    "callbackMailRejectedBody" : "<p>A continuación te mostramos el detalle del proceso de firma.</p><ul><li><strong>Estado del proceso</strong>: [STATUS]</li><li><strong>Título del proceso</strong>: [TITLE]</li><li><strong>Ref. del proceso</strong>: [MESSAGE_CODE]</li></ul><p>Si tienes alguna consulta recuerda usar el siguiente número de referencia: [MESSAGE_CODE] </p><p><br></p><p>Atentamente,</p><p>El equipo de viafirma documents.</p>",
    "callbackMailErrorSubject" : "Viafirma documents [SANDBOX]: proceso [MESSAGE_CODE] [STATUS]",
    "callbackMailErrorBody" : "<p>A continuación te mostramos el detalle del proceso de firma.</p><ul><li><strong>Estado del proceso</strong>: [STATUS]</li><li><strong>Título del proceso</strong>: [TITLE]</li><li><strong>Ref. del proceso</strong>: [MESSAGE_CODE]</li></ul><p>Si tienes alguna consulta recuerda usar el siguiente número de referencia: [MESSAGE_CODE] </p><p><br></p><p>Atentamente,</p><p>El equipo de viafirma documents.</p>"
}

Response: "string" (setCode ampliado)

Dónde se define la caducidad del SET

Por defecto la fecha de caducidad se hereda de la siguiente configuración:

• definida en la request,
• en ausencia de la anterior, se usa la configuración definida en el grupo utilizado,
• en ausencia de la anterior, se usa la configuración definida en el API utilizada,
• en ausencia de la anterior, se usa la configuración general definida en el backend del sistema.

Caducidad definida en la request

La caducidad es OPCIONAL a la hora de crear una nuevo SET, pero si se desea definir una caducidad por defecto basta con incluir el atributo opcional EXPIRES, medido en timestamp milliseconds.

{
"groupCode": "{{groupCode}}",
"title" :     "Título de mi SET",
"description" : "descripción de mi SET",
"expires": 1652876355000,
"recipients": [
    {
      "key": "signer1",
      "presential" : true
    }
  ],
  "messages" : [{
        "document" : {
            "templateType": "url",
            "templateReference": "{{pdf_url_sample}}"
        },
        "policies" : [ {
            "signatures" : [ {
                "type" : "CLIENT",
                "recipientKey" : "signer1"
            } ]
        } ]
    }]
}

Caducidad definida en el Grupo

Entre las poropiedades del grupo de trabajo se permite definir una caducidad por defecto de las peticiones realizadas desde el panel web de Viafirma Documents, y también aquellas peticiones definidas por APIs que no tuvieran definidas una caducidad. Solo el adminitrador del grupo propietario de la API podrá acceder desde el panel web de Viafirma Documents para definir esta propiedad.

Caducidad definida en el API

Entre las propiedades de las credenciales del API se puede definir una fecha de caducidad por defecto de todas las peticiones, y se mide en minutos. Solo el adminitrador del grupo propietario de la API podrá acceder desde el panel web de Viafirma Documents para definir esta propiedad.