Viafirma Documents

Descargar documento firmado

Revisión: 05-diciembre-2018

Para descargar documento firmado debes tener en cuenta lo siguiente:

  • debes conocer el messageCode asociado al proceso de firma.
  • el estado del proceso debe ser apto para poder descargar el documento.

Te lo explicamos a continuación:

Type Service Format Security
GET /api/v3/documents/download/signed application/json OAuth 1.0

Ejemplo GET DOWNLOAD SIGNED

GET api/v3/documents/download/signed/{messageCode}

Donde messageCode corresponde al código que devuelto por viafirma para cada nueva solicitud de proceso de firma.

Respuesta

Tendrás una respuesta en formato json con el estado y hora de la última actualización, tal y como te explicamos a continuación:

{
  "link": "string",
  "fileName": "string",
  "expires": "timestamp"
}
Param Desc
link URL para la descarga del documento. Esta URL NO es permanente, y caducará en la fecha y hora informada en el param expires.
fileName nombre del documento que se disopone a descargar.
expires el documento estará disponible para su descarga hasta la fecha y hora indicada en este param, en formato milliseconds. una vez caducado será necesario volver a consumir el servicio GET api/v3/documents/download/signed/{messageCode}

Ejemplo respuesta:

{
  "link": "https://ci.viafirma.com/documents/download/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJkb3dubG9hZFR5cGUiOiJTSUdORUQiLCJkb3dubG9hZE5hbWUiOiIxNTQwOTg4MTU0Njk4UjEzOS5wZGYiLCJkb3dubG9hZENvZGUiOiIxNTQwOTg4MTU0Njk4UjEzOSIsImRvd25sb2FkRXhwaXJlcyI6MTU0MTE2NTEwMTY2NX0.nacnFzDstsOVhhBLgQ9MyxAi4DtdHMyky05CcFM6xdg",
  "fileName": "1540988154698R139.pdf",
  "expires": 1541165101665
}

Errores

Los posibles errores serán devuelto en formato json:

{
    "code": "number",
    "type": "string",
    "message": "string"
}
Code Type Message Desc
81 Error El token utilizado por esta aplicación no es válido. Contacta con el administrador del sistema el consumer-key de las credenciales OAuth NO es correcto
85 Error Tu sesión ha sido cerrada por inactividad. Por favor ingresa nuevamente tus credenciales el consumer-secret de las credenciales OAuth no es correcto o estás usando unas credenciales del tipo USER en lugar del tipo API y en cuyo caso la sesión ha expirado.
91 Error Sorry, this application is not allowed. el API utilizada NO tiene permisos sobre el proceso, bien por que no es el propietario o porque pertenece a un groupCode sobre el que tampoco tiene permisos.
236 Error Unabled to retrieve the information of the selected message error al identificar el proceso con el MessageCode recibido, bien porque está equivocado o bien porque el proceso ya ha sido eliminado por alguna política de retención de documentos que haya activado el cliente en su configuración.
243 Error Estado no válido Estado del proceso no compatible para obtener el documento firmado.
313 Error Documento no encontrado El proceso es correcto, pero el documento firmado asociado al proceso ya no está disponible. Puede haber sido eliminado por la política de retención de documentos. Consulte la configuración del proceso.