Documentación Firmamos

En el presente documento define un diseño que busca facilitar la interacción de los comercios interesados en el uso de la plataforma Firmamos con los servicios de OLIMPIA IT - Reconocer por cuanto a la solicitud de validación de datos del cliente con servicio ANI, aprobación de tratamiento de datos públicos ATDP, proceso de validación, firma de PAGARÉS y recibo de archivos tipo pdf. En este orden de ideas, el presente documento se definen los contratos de servicio que corresponde al proceso definido en el presente servicio.

Este servicio se encarga de dar de alta al receptor para que pueda realizar de manera segura, la solicitud de cada uno de los servicios expuestos en el API.

{*****************************************************************************************************************************************"idAplicacion":**"32344164-aaaa-4bbb-b62b-cccc59f03433",*******************************************************************************"usuario":**"User",********************************************************************************************************************"contrasena":**"Password"***********************************************************************************************************}

*{********************************************************************************************************************************************************************************************************************************************************************************"Token":"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IjI3YTRmMTY0LWE4ZjMtNDM0ZC1iNjJiLWM4NTI1OWYwM2E2MiIsIm5iZi ****I6MTY1MTY5OTE2NywiZXhwIjoxNjUxNzg1NTY3LCJpYXQiOjE2NTi2OTkxNjd9.EatXojwblroNm6YxiaEPAOOLp0JLvGzec7OPPy3YJuw",***************************************************************************************************************************************************************}

El servicio se encarga del almacenamiento de las plantillas que va a ser ejecutadas en el servicio de múltiples documentos, hay que recalcar que los campos que se crean en el archivo PDF de plantilla deben estar congruentes con el servicio de múltiples documentos.

{****************************************************************************************************************************************"nombrePlantilla": "PruebaPlantilla",**************************************************************************************************"codigoPlantilla": "9d16f6b0-6aa3-430d-9a9c-fb856d648330",*****************************************************************************"version": "13"************************************************************************************************************************}

Este servicio se encarga de facilitar la aprobación de varios documentos por parte de los firmantes involucrados, con el fin de aumentar la efectividad y el tiempo de respuesta al momento de necesitar la aprobación de varios documentos por parte de uno o varios involucrados. Todos los documentos firmados con este método serán firmados electrónica y digitalmente. Para los documentos de vaucher y factura protegida es necesario tener un pagaré firmado, de lo contrario el sistema solicitara una petición con pagaré firmado

{****************************************************************************************************************************************"procesoClienteId":*"93",**************************************************************************************************************"numeroAprobacion":*"9",***************************************************************************************************************"tipoEndoso":*2,***********************************************************************************************************************"requiereATDP":*false,*****************************************************************************************************************"identificacionComercio":"12345678",***************************************************************************************************"plantillas":*[**************************************************************************************************************************{****************************************************************************************************************************************"plantillaCodigo":*"ed1b3554-5c26-4aa7-adc5-63d51d0d050e",*****************************************************************************"tipoDocumento":*3,********************************************************************************************************************"camposPlantilla":*[***********************************************************************************************************************{**************************************************************************************************************************************"CampoNombre":*"LugarPago",************************************************************************************************************"CampoValor":*"Bogota"******************************************************************************************************************************}*************************************************************************************************************************************]*************************************************************************************************************************************}*************************************************************************************************************************************}*************************************************************************************************************************************],*************************************************************************************************************************************"firmantes":*[***************************************************************************************************************************{*********************************************************************************************************************************"correoElectronico":*"Ejemplo_Prueba@olimpiait.com",***********************************************************************************"celular":*"1234568",******************************************************************************************************************"nombre":*"Juan",**********************************************************************************************************************"apellido":*"Perez",*******************************************************************************************************************"identificacion":*"**********",********************************************************************************************************"tipoIdentificacion":*1,***************************************************************************************************************"campoFirma":*"FirmaDeudor",***********************************************************************************************************"tipoInvolucrado":*1*****************************************************************************************************************}*************************************************************************************************************************************]*************************************************************************************************************************************}

{****************************************************************************************************************************************"procesoClienteId":*"91",**************************************************************************************************************"fechaSolicitud":*"2022-05-05T08:22:02.0045291-05:00",*********************************************************************************"urlAsesor":*"https://reconoserpruebas.olimpiait.com:7518/seguimiento/Aprobador?guid=baaawewqw-3c55-49a0-bd27-46b0c555730a",************"firmantes":*[*****************************************************************************************************************************{****************************************************************************************************************************************"correo":*"Prue.ebaEje@olimpiait.com",*************************************************************************************************"celular":*"1234552034",***************************************************************************************************************"solicitudEnviada":*true,**************************************************************************************************************"urlSolicitud":*"https://reconoserpruebas.olimpiait.com:7518/seguimiento/Aprobador?guid=1c6bbbbb-39c0-4ad2-a2f1-c3040b502c8a"***************}************************************************************************************************************************************],*************************************************************************************************************************************"resultado":*{*****************************************************************************************************************************"operacionExitosa":*true,***************************************************************************************************************"mensaje":*"Operacion realizada con exito",*********************************************************************************************"guidMesaAyuda":*"3a5e572e-5409-4de9-80b0-0d6cb27d7b38"********************************************************************************}************************************************************************************************************************************}

Este servicio se encarga de reenviar el SMS y correo electrónico con la información pertinente para firmar los documentos solicitados, esta funcionalidad se utiliza al momento de que el involucrado en la firma electrónica del documento excedió en tiempo limite para firmar o lo rechazo por error y se requiero hacer el envió nuevamente sin necesidad de realizar una nueva petición.

*{******************************************************************************************************************************************"codigo":*"1",**************************************************************************************************************************"mensaje";*"Reenvio de OTP exitoso"**************************************************************************************************}

Este servicio se encarga de suministrar el estado actual de las firmas electrónicos del documento o documentos consultados, para proporcionar información acerca de que involucrada ha firmado el documento, cual está pendiente por firmar y quien lo rechazo.

*{******************************************************************************************************************************************"idProceso": "ed1b3754-5c26-4aa7-adc5-63d51d0d050e",************************************************************************************"fechaConsulta": "2022-05-05T09:13:26.6466393-05:00",***********************************************************************************"firmas":*[********************************************************************************************************************************{*****************************************************************************************************************************************"nombreFirmante":*"Juan",**************************************************************************************************************"identificacion":*"1006123981",********************************************************************************************************"estadoFirma":*"Pendiente"**********************************************************************************************************},*************************************************************************************************************************************{*****************************************************************************************************************************************"nombreFirmante":*"Juan",**************************************************************************************************************"identificacion":*"1006123981",********************************************************************************************************"estadoFirma":*"Pendiente"*****************************************************************************************************************************}}********************************************************************************************************************************]**********************************************************************************************************************************}

Este servicio se encarga de facilitar la información del estado de las peticiones realizadas al API, detalla el servicio consumido la fecha en la que se realizó el consumo del servicio y si este fue exitoso o fallido

*{*****************************************************************************************************************************************"numeroAprobacion":*"19",**************************************************************************************************************"fechaSolicitud":*"2020-07-28T17:18:32.997",*******************************************************************************************"documentos":*[****************************************************************************************************************************{******************************************************************************************************************************************"ordenId":*1,**************************************************************************************************************************"serial":*"9ed1cH44-5254-4ce9-9b80-2931b328432e",**************************************************************************************"base64":*"JVBERi0xLjYKJeJeLjz9MKNTQgMCBvYm.....",*,***********************************************************************************"nombre":*"PruebaPortal"****************************************************************************************************************************}**********************************************************************************************************************************],*************************************************************************************************************************************"respuesta":*{*****************************************************************************************************************************"codigo":*1,***************************************************************************************************************************"mensaje":*"Operacion realizada exitosamente"***************************************************************************************}********************************************************************************************************************************}

El servicio se encarga de actualizar una plantilla que tenga un registro en la base de datos

{                                                                                                                                                                                                          "nombrePlantilla": "PruebaPlantilla",*                                                                                                         "codigoPlantilla": "9d16f6b0-6aa3-430d-9a9c-fb856d648330",                                                                                "version": "13"                                                                                                                                           }