Firma Embebida en una Aplicación de Terceros

Última revisión: 13 Abril 2021

Se parte del caso de uso siguiente:

  • Origen de la solicitud: aplicación web integrada con el API Viafirma.
  • Origen del PDF: admite todas las variantes disponible en el API: base64, generado a partir de plantilla o referenciado a partir de un PDF previamente firmado en Viafirma.
  • Destino: principalmente pensado para embeber la página de firma generada por Viafirma dentro de una aplicación de terceros, por ejemplo, a través de una web-view en una app móvil o en un i-frame dentro de una aplicación web de terceros (CRM, página web, etc.).
  • SERVICIO: /messages/dispatch
  • URL: {urlbase}/api/v3/messages/dispatch
  • SEGURIDAD:
  • METHOD: POST
  • CONTENT/APPLICATION: JSON
{
  "groupCode" : "string",
  "externalCode" : "string",
  "workflow" : {
    "type" : "PRESENTIAL"
  },
  "notification" : {
    "text" : "string",
    "detail" : "string"
  },
  "document" : {
    "templateCode" : "string"
  }
}

Descripción de PARAMS

  • "groupCode" : (string) código asignado a tu grupo de trabajo.
  • "externalCode" : (string)(opcional) te permite incluir un código interno de tu negocio con el que podrás hacer búsquedas indexadas, por ejemplo, tu número de expediente, contrato, factura, etc.
  • "workflow.type" : para este caso de uso siempre deberás usar el type "PRESENTIAL". De esta forma Viafirma no notificará mediante ningún canal al firmante, solo genera el link único de la página de firma que podrás embeber en tu sistema.
  • "notification.text" : (string) (opcional) mostrado como título en la pantalla de firma
  • "notification.detail" : (string) (opcional) mostrado como descripción en la pantalla de firma
  • "document.templateCode" : (string) código de la plantilla previamente configurado y que se usará para la construcción del PDF así como la definición de las políticas de firma entre otra configuración.

Respuesta

  • RESPONSE: 200 HTTP status code 200/OK
  • RESPONSE CONTENT TYPE: application/json

Donde encontrarás el objeto MESSAGE que incluye, entre otra información, el LINK (message.notification.sharedlink.link) de la página de firma que tendrás que embeber en tu aplicación web.

{
    "code": "string",
    "groupCode": "string",
    "workflow": {
        "current": "string",
        "history": [
            {
                "start": 0,
                "ends": 0,
                "taskName": "string",
                "order": 0
            }
        ],
        "initiate": 0,
        "lastUpdated": 0,
        "expires": 0,
        "type": "PRESENTIAL"
    },
    "notification": {
        "code": "string",
        "text": "string",
        "detail": "string",
        "sharedLink": {
            "link": "string"
        }
    },
    "document": {
        "templateCode": "string"
    },
    "policies": [{
            "signatures": [
                {
                    "code": "string"
                }
            ]
        }
    ]
}

Respuestas Error

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON con la descripción del problema:

    {
      "code": "string",
      "type": "string",
      "message": "string",
      "trace" : "string"
    }

results matching ""

    No results matching ""