1. Descripción de los métodos
En esta sección se encontrará el nombre, descripción, tipo de método, parámetros de entrada y de salida.Todos los métodos son síncronos reciben y devuelven texto simple en formato JSON. Las respuestas tienen el mismo formato, sin importar si son error o no:
Si se presenta algún error, el campo Data mostrará la información en el siguiente formato:
1.1. Forense
Este método se usa para obtener una lista de transacciones forenses con parámetros de entrada como filtros.
Tipo de método: Get
Endpoint: https://recidaw.olimpiait.com/Forense
1.1.1. Parámetros de entrada
1.1.2. Parámetros de Salida
1.2. ForenseGUI
Este método se usa para obtener detalles de una transacción forense específica.
Tipo de método: Get
Endpoint: https://recidaw.olimpiait.com/ForenseGuid
1.2.1. Parámetros de entrada
1.2.2. Parámetros de Salida
1.3. Motivos forenses
Este método se usa para obtener todos los motivos forenses.
Tipo de método: Get
Endpoint: https://recidaw.olimpiait.com/MotivosForense
1.3.1. Parámetros de entrada
1.3.2. Parámetros de Salida
1.4. Actualizar forense
Este método se usa para actualizar una transacción forense con su respectivo veredicto.
Tipo de método: Post
Endpoint: https://recidaw.olimpiait.com/ActualizarForense
1.4.1. Parámetros de entrada
1.4.2. Parámetros de Salida
1.5. Consultar estado forense
Este método permite consultar el estado actual de la transacción forense y conocer su veredicto.
Tipo de método: Get
Endpoint: https://recidaw.olimpiait.com/ConsultarEstadoForense
1.5.1. Parámetros de entrada
1.5.2. Parámetros de Salida
1.6. Solicitar revisión forense
Este método se usa para solicitar una revisión forense.
Tipo de método: Post
Endpoint: https://recidaw.olimpiait.com/SolicitarRevisionForense
1.6.1. Parámetros de entrada
1.6.2. Parámetros de Salida
1.7. Liberar forense
Este un método se usa para libera la transacción forense para que pueda ser visto por otro usuario.
Tipo de método: Post
Endpoint: https://recidaw.olimpiait.com/LiberarForense
1.7.1. Parámetros de entrada
1.7.2. Parámetros de Salida
2. Preguntas frecuentes
Este campo ha sido creado para ayudarte a resolver posibles errores que puedan presentarse al utilizar estos procesos y para aclarar cualquier duda sobre algunos de los campos.
2.1. Motivos de rechazo procesos
A continuación, te compartimos algunos de los motivos por los cuales los procesos pueden ser aprobados o rechazados. En algunos casos, el rechazo puede deberse a más de una razón:
2.2. Consultar estado forense
Este método funciona por medio de un filtro, donde debemos ingresar el “Identificador Forense”, la siguiente imagen es un ejemplo de un resultado correcto al usarlo:
Este sería la respuesta al ingresar erróneamente el “Identificador Forense”:
2.3. Solicitar revisión forense
Esta es una repuesta correcta al hacer una solicitud de revisión Forense:
Esta es cuando el convenio no existe o está mal ingresado:
2.4. Errores
Si aparece un error de no autorizado, solo necesitas refrescar tu Token para continuar con el proceso.
Intermitencia base de datos, hace referencia a un error masivo que se da por sobrecarga en la base de datos, es necesario reportarlo a soporte.
3. Guía para consumir métodos del API
Aquí encontrarás una breve explicación de algunos métodos de la API, con indicaciones sobre su uso adecuado, posibles errores que pueden presentarse, las respuestas generadas y otra información relevante para ayudarte en el proceso.
3.1. Token
Este método cumple la función de llave, la cual habilita los métodos y permite usarlos, el método se usa de la siguiente manera:
-
Tenemos que habilitar el método dando clic el botón Try It out.
-
Esto habilitara un campo de texto que nos permite ingresar las credenciales y en la parte superior del método se encuentra un pequeño ejemplo de los datos a ingresar.
-
Al final le damos clic en el botón Execute y nos muestra la siguiente respuesta:
-
Copiamos el Token, nos dirigimos a la parte superior de la página y le damos clic al botón Authorize, nos muestra un Pop Up donde hay un campo de texto para pegar el token, pero primero debemos escribir la palabra Bearer, damos clic en la barra espaciadora y pegamos el token.
Haz clic en el botón "Authorize" y cierra la ventana emergente. ¡Listo! Después de estos pasos ya puedes utilizar los métodos disponibles.
3.2. Solicitud revisión forense
Este método te permite solicitar la validación de un documento de identidad y requiere que ingreses los siguientes datos para completar el proceso:
- Identificador del convenio
- Tipo y número de documento del ciudadano, los tipos de documento se encuentran en la descripción de los parámetros de entrada.
- Un array donde también ingresaremos los siguientes datos:
Tipo objeto: Ingresar si va a validar la parte Anverso o reverso del documento de identidad.
Objeto: Imagen en base 64 del documento.
Formato objeto: Si el objeto cargado es JPG O PNG.
Para usar adecuadamente este método, debemos de ingresar bien la información que nos solicita y al final le damos clic en el botón Execute y nos muestra la siguiente respuesta:
En la repuesta podemos ver el identificador del proceso que se encuentra resaltado y el código de ejecución que cuando es correcto es “200” si no muestra un código diferente.
3.3. Consultar estado forense
Este método se usa para consultar el estado de una validación Forense, se realiza ingresando el Identificador del Proceso por medio de un filtro.
Una descripción más clara de la repuesta del método se encuentra en los parámetros de salida, los motivos de rechazo y aceptación se encuentran motivos de rechazo procesos.
4. Métodos del API en postman
Esta sección explica brevemente cómo usar las siguiente APIS de forense en Postman.
4.1. Soporte forense
Esta colección incluye tres métodos: uno para autenticarse, otro para consultar el estado de un proceso y el último para crear un proceso forense. Recuerda que, para utilizar los dos últimos, primero debes solicitar el token.
Luego en la consulta “Get Obtener Estado Proceso Forense”, pegamos el token en Authorization y, en Params pegamos el GUID y lo ejecutamos.
- Authorization
- Params
-
Esta es la respuesta de la consulta:
Una descripción más clara de la repuesta del método se encuentra en los parámetros de salida, los motivos de rechazo y aceptación se encuentran en motivos de rechazo procesos.
Este método está diseñado para crear una solicitud forense (“POST Crear Forense”). Solicita datos como el identificador del convenio, el ID y número del tipo de documento del ciudadano, el tipo de objeto (por ejemplo, una foto del rostro si es frontal, o imágenes del anverso/reverso del documento de identidad), así como la imagen en formato base 64 y su formato (JPG o PNG).
Podemos repetir el mismo paso del Token en el método anterior, en caso de que estén en Authorization y no pueda ver el campo para pegar el token, le dan clic en el sector y selecciona el tipo “Bearer Token”.
La respuesta al ejecutar el método es la siguiente:
4.2. Soporte forense Dev
Los métodos de esta colección funcionan igual que los de la anterior, solo debes tener en cuenta que cambia la URL.
Para Soporte Forense la URL es la siguiente.
Para Soporte Forense Dev la URL es la siguiente.
5. Control de cambios
| VERSIÓN | FECHA | DESCRIPCIÓN |
| 1 | 2021-09-28 | Creación del documento |
6. 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.
Documento de Olimpia – Uso PÚBLICO