Descarga de un documento firmado
Revisión: 23-octubre-2018
El servicio disponible en el API para descargar el documento firmado es el siguiente:
GET api/v3/documents/download/signed/{messageCode}
Obteniendo una respuesta en formato Application/JSON como la siguiente:
{
"link": "string",
"md5": "string",
"fileName": "string",
"expires": "string"
}
donde:
Param | Desc |
---|---|
link | Link autogenerado para la descarga del documento firmado; este link tiene una validez de 10 minutos; superado ese tiempo es necesario volver a consumir el servicio. |
md5 | hash del contenido del documento firmado para facilitar procesos de verificación y autenticidad. |
fileName | nombre del documento firmado; por defecto el nombre de los documentos firmados será igual el messageCode del proceso más la extensión .pdf. |
expires | fecha y hora en formato milisegundos que indica el vencimiento del LINK de descarga. Por defecto son 10 minutos. |
¿Cuándo debo consumir el servicio?
Existen múltiples estados en función del workflow implementado, y por ello no todos los estados estarán asociados a un documento ya firmado. Un documento firmado podrá descargarse si está en alguno de los siguientes estados:
Status | Desc |
---|---|
FINISHED | proceso finalizado correctamente, donde el usuario NO ha rechazado la solicitud y el documento ya ha sido firmado, pudiendo incluir evidencias adicionales según la política de firma utilizada. |
RESPONSED | Tras finalizar el proceso se ha hecho algún tipo de callback, por ejemplo callbackURL o callbackMail. Este estado también permite consumir el servicio para obtener el documento firmado. |
TRANSFERRED | Además del callback realizado, el proceso o el grupo al que pertenece están asociados a una transferencia automática del documento firmado a un repositorio externo. |
MAX_ERROR_REACHED | La trasnferencia al repositorio externo ha fallado. Durante ese período de tiempo el documento firmado sigue estando en viafirma, por lo que en este estado también es posible consumir el servicio para descargar el documento firmado. |
Recuerda para que para conocer el estado de un proceso podrás usar el siguiente servicio disponible en el API:
GET api/v3/messages/{messageCode}
y que te explicamos en esta otra guía: detalle de un proceso
results matching ""
No results matching ""