Introducción #
Con el presente documento se busca facilitar la interacción de los comercios interesados en el uso de la plataforma Mis Pagarés con los servicios de OLIMPIA IT 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.
Descripción del proceso Mis Pagarés #
Consumo API Mis Pagarés #
Se realiza la conexión por medio del navegador, con la URL Mis Pagarés – API – Swagger UI (olimpiait.com) , Aquí se tendrá acceso a los diferentes métodos GET y POST del API.
Autenticación #
Inicio de sesión #
Este servicio se encarga de alta al receptor para que pueda realizar de manera segura, la solicitud de cada uno de los servicios expuestos en el API.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- Errada:
Proceso general #
Iniciar #
Este servicio realiza la creación del proceso para la firma del pagaré, donde es necesario enviar los datos del deudor para registrarlo en el sistema junto con el idProcesoCliente, el cual es único para cada cliente. Dicho idProcesoCliente puede generarse de forma automática o según los parámetros del cliente.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Errada:
Estructura modelo de respuesta #
Proceso estado pagaré #
Este servicio permite consultar el estado de un pagaré y su ultimo Endoso, para consultar la información es a través del Serial o del IdProcesoCliente, los parámetros Serial o IdProcesoCliente son opcionales, mínimo debe ingresar uno.
Operación #
Estructura modelo de consulta #
- Consulta:
Respuesta: #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- No exitosa:
No se encuentra la información enviada:
Estructura modo de respuesta #
Información #
Este servicio permite consultar el estado de un proceso deseado obteniendo sus transacciones, documentos y firmantes. Para consultar el estado es necesario digitar el idProcesoClienteExterno del proceso:
Operación #
Estructura modelo de consulta #
- Consulta:
Respuesta: #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- No Exitosa:
No se encuentra la información enviada:
Estructura modelo de respuesta #
Estado #
Este servicio permite consultar el estado del proceso deseado. Para consultar el estado es necesario digitar el idProcesoClienteExterno del proceso:
Operación #
Estructura modelo de consulta #
- Consulta:
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- No Exitosa:
No se encuentra la información enviada:
Estructura modelo de respuesta #
Documento/Estado #
Por medio de este servicio se consulta el estado de las firmas de los documentos. Para consultar el estado de un documento se puede realizar de dos maneras, una es con el número serial del documento (serialDocumento) y la otra es con el numero de la transacción (idTransacción).
Operación #
Estructura modelo de consulta #
- Consulta:
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- No exitosa:
Estructura modelo de respuesta #
Proceso #
Consulta ANI #
Por medio de este servicio se requiere consultar el documento de identidad en el servicio ANI y emitir documentos por medio de este proceso.
Operación #
Estructura modelo consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- No Exitosa:
- Fallida por flujo:
Estructura modelo de respuesta #
Anexo #
Por medio de este servicio se almacenan los documentos de tipo cedula y facturación para que sea anexado a la información del solicitante del crédito y sus codeudores, según sea el caso.
Operación #
Estructura modelo consulta #
Nota: para el adjunto del documento en base64, solo permite el ingreso de un tope máximo de 10 MB
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- No exitosa:
Estructura modelo de respuesta #
Emitir documento #
Por medio de este servicio se emiten los documentos (pagaré, ATDP, etc.) para posteriormente ser firmados por el solicitante del crédito y sus codeudores, según sea el caso.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Emitir múltiples documentos #
Por medio de este servicio se emiten varios documentos en un solo proceso (pagarés y documentos adicionales) para posteriormente ser firmados por el solicitante del crédito y sus codeudores, según sea el caso.
Operación #
Estructura modelo consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas
- Exitosa:
- No Exitosa:
- Fallida por flujo:
Estructura modelo de respuesta #
Emitir base64 #
Por medio de este servicio se emiten los documentos en formato Base64 (pagaré, ATDP, etc.) para posteriormente ser firmados por el solicitante del crédito y sus codeudores, según sea el caso.
Operación #
Estructura modelo de consulta #
NOTA: El documento base64 debe de traer un campo de firma y ese campo de firma es el que se indica en la petición donde va a colocar la firma electrónica “CampoFirma”.
Petición #
NOTA: No Eliminar ninguno de los campos, así no se utilice o no sean necesarios en la petición que se emita.
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta Mi Firma: #
Estructura modelo de respuesta Embebido #
Proceso embebido #
Plantillas – Cargar una plantilla #
Por medio de este servicio se pueden cargar plantillas al sistema para el proceso embebido.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Plantillas – Obtener campos de una plantilla #
Por medio de este servicio se pueden obtener los campos de una plantilla.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Plantillas – Actualizar una plantilla #
Por medio de este servicio se puede actualizar una plantilla ya existente.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Previsualizar plantilla #
Por medio de este servicio se puede visualizar como se visualiza un pagaré diligenciado desde una plantilla. Es devuelto en formato base64.
Operación #
Estructura modelo de consulta #
Petición #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Emitir múltiples documentos #
Por medio de este servicio se emiten los documentos (pagaré, ATDP, etc.) por el proceso embebido para posteriormente ser firmados por el solicitante del crédito y sus codeudores, según sea el caso.
Operación #
Estructura modelo de consulta #
Petición: #
Respuesta #
Los siguientes son ejemplos de sus posibles respuestas.
- Exitosa:
- Fallida por datos:
- Fallida por flujo:
Estructura modelo de respuesta #
Requisitos del sistema #
- Servidor
Debido a que el sistema no presenta grandes volúmenes de información almacenada se considera que es viable que el Application Server y el Database Server pueden estar en el mismo servidor. A continuación, se detallan por separado los 2 servidores.
- Equipo de cliente
Para poder acceder a la aplicación los PC’s de los Usuarios deberán tener las siguientes características:
Control de cambios #
VERSIÓN | FECHA | DESCRIPCIÓN |
1 | 2021-11-09 | Creación de Documento |
2 | 2022-02-25 | Ajuste de imágenes |
3 | 2022-03-11 | Ingreso de nuevos módulos |
4 | 2022-06-01 | Ajuste de redacción e imágenes |
5 | 2022-12-05 | Actualización nuevos procesos |
6 | 2023-14-04 | Actualización de Documento |
7 | 2023-08-02 | Reenviar OTP |
8 | 2023-08-03 | Corrección de la URL del api de Mis Pagares |
9 | 2023-08-09 | Se actualiza método de emisión base64 |
10 | 2023-10-04 | Actualización emisión base64 para embebido e Identificación para los documentos |
11 | 2023-10-23 | Actualización método Descarga Pagare |
Propiedad de Olimpia #
El presente documento es de carácter confidencial y está protegido por las normas de derechos de autor, cualquier reproducción, distribución o modificación total o parcial a usuarios no autorizados o cualquier uso indebido de la información confidencial será considerado un delito conforme a lo establecido por el Código Penal y Leyes vigentes del estado Colombiano.