Descargar un documento firmado

Última revisión: 15 Noviembre 2023

Se parte del siguiente caso de uso:

  • Propietario del proceso: API
Descripción
SERVICIO DOWNLOAD SIGNED DOCUMENT
URL /api/v3/documents/download/signed/{messageCode}
SEGURIDAD
METHOD GET
CONTENT/APPLICATION URL PARAM
PARAMS messageCode: código devuelto por Viafirma asociado al proceso que se desea interrogar. El API que lo consume debe ser propietario del proceso. Cuando el proceso de firma se corresponda a un SET, podrán haber varios documentos firmados, y por tanto varios messageCodes.
RESPONSE 200: HTTP status code 200/OK

Response body:

    {
        "link": "string",
        "fileName": "string",
        "hash" : "string",
        "expires": 0
    }

Ejemplo:

    {
      "link": "https://sandbox.viafirma.com/documents/download/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkb3dubG9hZFR5cGUiOiJTSUdORUQiLCJkb3dubG9hZE5hbWUiOiIxNTYyNTc4ODE2OTU2UjQ3My5wZGYiLCJkb3dubG9hZENvZGUiOiIxNTYyNTc4ODE2OTU2UjQ3MyIsImRvd25sb2FkRXhwaXJlcyI6MTU2MU5MTU5NDgzNX0.4mfzLbf8xZLECEc66H8N-u7bGQF-QXIUh9J993IZYHU",
      "fileName": "1562578816956R473.pdf",
      "hash" : "f304c3840511e38744b5d036040545e965da6bdb3d5e9788f3ff3e2bcecab2c6",
      "expires": 1658318515322
    }

Params de la respuesta:

  • Link: URL única y temporal en la que se puede descargar el PDF.
  • FileName: nombre del PDF.
  • Hash: SHA256 del documento firmado.
  • Expires: fecha de expiración del link de descarga en formato timestamp epoch (por defecto 10 minutos).

Respuestas alternativas en caso de fallo: se devolverán HTTP status codes distintos de 200/OK. En ese caso siempre se devolverá un JSON que describe el problema:

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

Ej. el documento aún no ha sido firmado, estado actual “WAITING”.

    {
     "code": 243,
     "type": "Error",
     "message": "El estado de la solicitud no es válido."
    }

Ej. el API que lo consume no es propietario del proceso.

    {
     "code": 91,
     "type": "Error",
     "message": "Sorry, this application is not allowed."
    }

Ej. Documento eliminado

    {
    "code": 313,
    "type": "Error",
    "message": "The process is correct, but the signed document linked to the process is no longer available. It may have been removed by the document retention policy. See process configuration.",
    "trace": "string"
}

results matching ""

    No results matching ""