...
...
...
...
...
...
...
...
...
...
VERSIONAMIENTO DEL DOCUMENTO
Fecha | Versión | Autor | Descripción |
2021-09-10 | 0.1 | Cristhian David Sandoval Pazu | Elaboración de la versión inicial. |
2021-10-22 | 1.1 | Cristhian David Sandoval Pazu | Ajuste "base64String": "Reemplazar por un string base 64 pdf " |
2022-06-13 | 1.2 | Erika Marcela Romero Gómez | Agrega tabla que describe los parámetros del objeto json requerido para la creación de un proceso y añade ejemplo para cada tipo de proceso. Agrega información referente a los estados de un proceso. |
2022-08-05 | 1.3 | Richard Barboza | Agrega documentación V2 API para processcreatefull con el nuevo campo balanceType. |
APROBACIONES DEL DOCUMENTO
Fecha | Versión | Aprobador | Dependencia / Cargo |
2021-09-10 | 1.0 | Cristhian Sandoval | Desarrollador líder I+D+I |
2021-09-10 | 1.0 | Danny Guarin | Director Desarrollo de Negocios |
2021-10-29 | 1.1 | Cristhian Sandoval | Desarrollador líder I+D+I |
2021-10-29 | 1.1 | Danny Guarin | Director Desarrollo de Negocios |
2022-06-13 | 1.2 | Daniel Giraldo | Analista de pruebas |
2022-08-07 | 1.3 | Daniel Giraldo | Analista de pruebas |
...
También se evidencian consideraciones y prerrequisitos necesarios para realizar una integración con otras soluciones.
TÉRMINOS GENERALES
1.1 Proceso
Un proceso es el conjunto de firmantes que tienen como propósito firmar electrónicamente un documento pdf.
...
Es una de las estrategias propuestas por Firma Seguro API para devolver el documento pdf firmado en base 64, en este caso es necesario que el sistema cliente implemente un end point al cual Firma Seguro API responderá cuando el proceso esté terminado exitosamente.
CREAR UN PROCESO.
Diagrama de secuencia “Creación de proceso”
...
{
"email": "csandoval@tredasolutions.com",
"password": "%AL1h45g6Jw0PChDKKSXRpcFnw"
...
2.8 Ejecutar el request ProcessCreateFull: Ejemplos
Tipo de proceso “Solo yo”: Único firmante
{
"processTypeId": 1,
"signatureMethodId": 2,
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"messageEmail": "primera firma desde la api firmaseguro",
"copyEmails": "juan.perez@email.com, nina.tul@email.com"
}
Nota: Recordar que la persona que firma en el tipo de proceso “Solo yo” debe ser la misma que está autenticada en la api.
Tipo de proceso “Otros y yo”: Mínimo 2 firmantes, máximo 10
{
"processTypeId": 2,
"signatureMethodId": 1,
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"phoneId": 0,
"email": "juan.perez@email.com",
"personId": 0,
...
"messageEmail": "primera firma desde la api firmaseguro",
"copyEmails": ""
}
Nota: Recordar que las personas que firman en el tipo de proceso “Otros y yo” debe ser la misma que está autenticada en la api, quien hace el papel del YO y otras personas ajenas.
Tipo de proceso “Solo Otros”: Mínimo 1 firmante, máximo 10
{
"processTypeId": 3,
"signatureMethodId": 2,
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"messageEmail": "primera firma desde la api firmaseguro",
"copyEmails": "juan.perez@email.com, nina.tul@email.com"
}
Nota: Recordar que las personas que firman en el tipo de proceso “Solo otros” son otras personas ajenas a quien se encuentra autenticado.
...
"uuid": "string"
}
OBTENER DOCUMENTO “ESTRATEGIA POLLING”.
...
Diagrama de secuencia obtener documento
...
curl --location --request GET 'https://demo.firmaseguro.co/api/v1/Document/ByUUID/uuid' \
--header 'Authorization: Bearer Token'
...
"documents": [Base64String],
"uuid": "string"
}
OBTENER DOCUMENTO “ESTRATEGIA CALLBACK”. (RECOMENDADO)
...
Diagrama de secuencia obtener documento
...
Response Sign I
No aplica.
CREAR UN PROCESO CON LA V2 DE LA API
5.1 Ir a la parte superior y seleccionar la versión 2 de la API
...
Para la V2 de la API se necesitará enviar al tipo de saldo(BalanceTypeId), 1 para saldo por firmas y 2 para saldo por documentos. Es necesario que los firmantes tengan el mismo método de autenticación cuando el tipo de saldo sea por documentos (BalanceTypeId igual a 2), por ejemplo por SMS(2) o Email(3). Nota: el tipo de autenticación por llamada(1) no está habilitado para saldos por documentos.
Ejemplos
Tipo de proceso “Solo yo” - Saldo por documentos: Único firmante
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"messageEmail": "primera firma desde la api firmaseguro",
"copyEmails": "juan.perez@email.com, nina.tul@email.com"
}
Nota: Recordar que la persona que firma en el tipo de proceso “Solo yo” debe ser la misma que está autenticada en la api, y con tipo de saldo por documentos - Email (Todos los firmantes deben de tener el mismo método de autenticación, en este caso de ejemplo, es el Email).
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"phoneId": 0,
"email": "juan.perez@email.com",
"personId": 0,
...
"phoneId": 0,
"email": "jhon.doe@email.com",
"personId": 0,
...
"messageEmail": "primera firma desde la api firmaseguro",
"copyEmails": "juan.perez@email.com, nina.tul@email.com"
}
Nota: Recordar que las personas que firman en el tipo de proceso “Solo otros” son otras personas ajenas a quien se encuentra autenticado, con tipo de saldo por documentos - SMS (Todos los firmantes deben de tener el mismo método de autenticación, en este caso SMS).
...