Información de un proceso
Revisión: 23-octubre-2018
El servicio disponible en el API para conocer el estado y detalle de un proceso es siguiente:
GET api/v3/message/{messageCode}
Obteniendo una respuesta en formato Application/JSON como la siguiente:
{
"code": "string",
"userCode": "string",
"groupCode": "string",
"appCode": "string",
"workflow": {
"current": "string",
"history": [
{
"start": "timestamp",
"ends": "timestamp",
"taskName": "string"
}
],
"initiate": "timestamp",
"lastUpdated": "timestamp",
"expires": "timestamp",
"type": "string"
},
"notification": {
"code": "string",
"text": "string",
"detail": "string",
"sharedLink": {
"scheme": "string",
"token": "string",
"link": "string",
"appCode": "string",
"subject": "string"
}
},
"document": {
"templateCode": "string",
"templateVersion": "number",
"draftedCode": "string",
"signedCode": "string",
"signedID": "string",
"templateType": "string",
"formRequired": "boolean",
"items": [
{
"key": "string",
"value": "string"
}
],
"numPages": 1
},
"policies": [
{
"code": "string",
"evidences": [
{
"type": "string",
"code": "string",
"status": "string",
"helpText": "string",
"positions": [
{
"rectangle": {
"x": "number",
"y": "number",
"width": "number",
"height": "number"
},
"page": "number"
}
],
"metadataList": [
{
"key": "string",
"value": "string"
}
],
"typeFormatSign": "string",
"geolocation": {
"accuracy": "number",
"latitude": "number",
"longitude": "number"
}
}
],
"signatures": [
{
"type": "string",
"code": "string",
"status": "string",
"helpText": "string",
"certificateAlias": "string",
"typeFormatSign": "string",
"idSign": "string",
"stampers": [
{
"type": "string",
"rotation": "string",
"width": "number",
"height": "number",
"xAxis": "number",
"yAxis": "number",
"page": "number"
}
]
}
]
}
],
"server": "string",
"auditory": [
{
"date": "timestamp",
"ip": "string",
"action": "string",
"detail": ""
}
]
}
A continuación la explicación de los distintos atributos y objetos contenidos en la respuesta:
Message
{
"code": "string",
"userCode": "string",
"groupCode": "string",
"appCode": "string"
}
donde:
Param | Desc |
---|---|
code | código del proceso con el que podrás identificar al proceso para el resto de servicios disponibles en el API. |
userCode | código del usuario propietario del proceso |
groupCode | código del grupo desde el que el propietario generó el proceso; el grupo podrá determinar comportamiento específico de negocio. |
appCode | aplicación desde la que se generó el proceso; cuando el proceso se generó desde el backend de viafirma, el código será el asociado la aplicación Documents Backend , normalmente identificada por defecto con el código com.viafirma.mobile.services . |
Workflow
Objeto con la información sobre el estado y detalle de las distintas tareas asociadas al ciclo de vida del proceso. Este ciclo de vida variará de un proceso a otro en función de múltiples factores: tipo de proceso de firma (Firma remota, firma presencial), tipo de transferencias, tipo de validaciones, etc.
{
"workflow": {
"current": "string",
"history": [
{
"start": "timestamp",
"ends": "timestamp",
"taskName": "string"
}
],
"initiate": "timestamp",
"lastUpdated": "timestamp",
"expires": "timestamp",
"type": "string"
}
}
donde:
Param | Desc |
---|---|
current | estado actual del proceso; ver lista de estados disponibles |
history | lista de estados por los que el proceso ha pasado, incluyendo para cada uno la fecha y hora expresada en milisegundos para el inicio y fin y el nombre de la tarea. |
initiate | fecha y hora en la que se inició el proceso, expreado en milisegundos |
lastUpdated | fecha y hora de la última actualización del proceso, expreado en milisegundos |
expires | fecha y hora en la que el proceso caducará, expresado en milisegundos . La caducidad del proceso se configura por defecto en la propiedades de la aplicación propietaria del proceso (ver fecha y hora en la que se inició el proceso, expreado en appCode ), o bien la fecha de caducidad explícita indicada por el integrador a la hora de consumir el servicio mediante API |
type | tipo de proceso; ver lista de procesos disponibles |
Lista de estados disponibles:
- DELETED
- EXPIRED
- ERROR
- REJECTED
- TRANSFERRED
- RESPONSED
- SERVER_SIGN
- SENT
- SIGNED
- WAITING
- COMMITTED
- RECEIVED
- TEMPORAL_STORED
- STAND_BY
- WAITING_CHECK
- APPROVED
- FINISHED
- WAITING_OCR
- WAITING_CLIENT_SIGNATURE
- MAX_ERROR_REACHED
Lista de procesos disponibles:
WORKFLOW TYPE | DESC |
---|---|
APP | Proceso donde el documento es enviado a la app de viafirma en un dispositivo móvil, notificando al destinatario mediante una notificación push. |
WEB | Proceso donde el documento es procesado desde una página web autogenerada por viafirma y notificada al destintario de la notificación vía EMAIL y/o SMS. |
PRESENTIAL | Mismo procedimiento utilizado para WEB pero no hay notificación a ningún destinatario, sino que el link autogenerado por viafirma es consumido vía API por otra aplicación, por ejemplo para embeber la página de firma en una web-view de otra app o de una web-app. Este tipo de proceso es el indicado para el uso de firma biométrica basada en el uso de pads de firma WACOM. También es el proceso utilizado para procesos de firma con certificado digital a través de la app viafirma documents desktop. |
Notification
{
"notification": {
"code": "string",
"text": "string",
"detail": "string",
"sharedLink": {
"scheme": "string",
"token": "string",
"link": "string",
"appCode": "string",
"subject": "string"
}
}
}
results matching ""
No results matching ""