Ir directamente al contenido
  • No hay sugerencias porque el campo de búsqueda está vacío.

Manual de usuario RNEC Modo Integrado

1. INTRODUCCIÓN

1.1. Propósito

En el producto ReconoSer - Modo Integrado, la aplicación Windows ReconoSer se conecta de manera amigable con el backend del cliente utilizando un servicio REST. Esto te permite crear solicitudes de validación biométrica, consultar cómo van esas solicitudes y cancelar aquellas que aún no se hayan completado.

1.2. Envíe sus comentarios del manual

¡Nos encantaría conocer tus comentarios y sugerencias sobre el Manual de Usuario! Tus ideas son muy valiosas para ayudarnos a mejorar y desarrollar futuras versiones de este documento. Los comentarios los podrá realizar a la cuenta de correo: SoporteCorporativo@olimpiait.com

2. UBICACIÓN DEL SERVICIO

El servicio REST ha sido expuesto en las siguientes URL:

  • https://xx.xx.xx.xx:XXXX/api/Solicitudes 
  • https://xx.xx.xx.xx:XXXX/api/SolicitudesEstado

3. RECOMENDACIONES:

Para que todo el proceso de acciones sobre el servicio REST sea más rápido y sencillo, ten en cuenta lo siguiente:

  • El cliente debe existir y estar activo en la DB de Olimpia.
  • El cliente debe tener configurado un convenio de autenticación.
  • El cliente debe tener registradas las oficinas y productos correspondientes.
  • Las oficinas deben tener configuradas la máquinas para la consulta, creación o actualización de las solicitudes y su respectivo tipo de identificador (MAC, IP, NOMBRE etc...).

Si no has configurado previamente las recomendaciones usando el portal cliente y el portal de operación, no te preocupes. Estos portales están diseñados para facilitarte la creación de todos estos detalles. Si necesitas ayuda, no dudes en ponerte en contacto con nuestra línea de Asistencia Técnica para obtener las instrucciones necesarias.

4. CREAR O ACTUALIZAR SOLICITUDES

Para crear o actualizar una solicitud, simplemente envía la petición con los parámetros necesarios y el verbo HTTP que te indicamos a continuación:

Se deben enviar en formato JSON de la siguiente forma:

Manual_07_RECONOSER_1

Por favor, reemplaza los datos de la imagen con los valores que correspondan.

Si envías la petición correctamente, el servicio te dará una respuesta como esta:

Respuesta de petición:

Manual_07_RECONOSER_2

Si necesitas, puedes guardar el campo “PeticionRegistrada” para que puedas cambiar el estado de la solicitud a “CANCELADA” o hacerle seguimiento. Solo asegúrate de tener este identificador a mano. Este identificador está vinculado en la base de datos de ReconoSer y es igual al NUT de validación con RNEC. Además, lo encontrarás en la metadata del formato de autorización de tratamiento de datos para asegurar que todo esté en orden.

Nota: Puedes encontrar los códigos de error en el índice del Apartado de excepciones.

Definición de campos:

Campo

Tipo

Tamaño

IdCliente

integer

 

IdConvenioAutenticacion

globally unique identifier

 

IdSolicitudCliente

string

60

UsuarioCreacion

string

50

TipoDocumentoCandidato

string

2

Candidato

string

20

codigoProducto

string

20

codigoOficina

string

20

Maquina

string

50

TipoIdentidadMaquina

integer

 

TiempoValidez

integer

 

5. CANCELAR UNA SOLICITUD

Para cancelar una solicitud, simplemente envía la petición con los parámetros necesarios y el verbo HTTP que te indicamos a continuación:

  • URL de servicio: https://xx.xx.xx.xx:6401/api/Solicitudes
  • Verbo: PUT
  • Parámetros: (idCliente, convenio, idPeticion). Estos parámetros pueden ser enviados de la siguiente forma o la que mejor se ajuste a los estándares de desarrollo que maneje.

https://xx.xx.xx.xx:6401 /api/Solicitudes?idCliente=1052&convenio=EC09446C-4A5A-4C26- AF1E0C7C5C4423FF&idPeticion=3987b6b5-9b90-40a0-af8c-f5a0d6ac99d4

Si envías la petición correctamente, el servicio te dará una respuesta como esta:

Petición de respuesta:

Manual_07_RECONOSER_3

Nota: Puedes encontrar los códigos de error en el índice del Apartado de excepciones.

6. CONSULTAR UNA SOLICITUD

Para consultar una solicitud, solo necesitas enviar la petición con los parámetros adecuados y el verbo HTTP que te indicamos a continuación:

  • URL de servicio: https://xx.xx.xx.xx:6401/api/SolicitudesEstado
  • Verbo: GET
  • Parámetros: (idCliente, convenio, idPeticion). Estos parámetros pueden ser enviados de la siguiente forma o la que mejor se ajuste a los estándares de desarrollo que maneje.

https://xx.xx.xx.xx:6401/api/Solicitudes?idCliente=1052&convenio=EC09446C-4A5A-4C26- AF1E0C7C5C4423FF&idPeticion=3987b6b5-9b90-40a0-af8c-f5a0d6ac99d4

Si envías la petición correctamente, el servicio te dará una respuesta como esta:

Petición de respuesta:

Manual_07_RECONOSER_4

A continuación, te describimos las posibles respuestas entregadas por el servicio basados en cada uno de los estados manejados por el servicio:

  • Si la solicitud es cancelada antes de realizar la validación de identidad obtendrás una respuesta como la siguiente:
    Manual_07_RECONOSER_5

En esta respuesta el parámetro “EstadoSolicitud” retornara “CANCELADA”

  • Si la respuesta de la solicitud es un “NOHIT”, siendo este el resultado al no haber coincidencia en las huellas al momento de la comparación, la respuesta que retornará el servicio será:
    Manual_07_RECONOSER_6

  • En el proceso de la solución de ReconoSer, puedes intentar validar de nuevo, incluso si ya lo has hecho. Al usar el mismo número de IdPeticion, la solicitud volverá al estado de "creada", aunque la validación haya sido exitosa, como se muestra en la imagen siguiente:

    Manual_07_RECONOSER_7

    • Ten en cuenta que la solicitud tiene un tiempo de expiración. Este es uno de los parámetros que debes considerar al hacer la petición. Si la solicitud expira, el estado cambiará a "CANCELADA" en el parámetro "EstadoSolicitud", tal como se muestra en la imagen siguiente.

      Manual_07_RECONOSER_8

    Ten en cuenta que la autocancelación solo se lleva a cabo si la aplicación de ReconoSer está funcionando o si se encuentra activa durante el tiempo en que la solicitud expira.

    Nota: Si el campo “Respuesta Solicitud” es NOHIT o CANCELADA, el servicio no podrá devolver la información del candidato. Pero no te preocupes, puedes encontrar los códigos de error en el índice del Apartado de excepciones, donde también se detallan los valores de los parámetros CodigoError y DescripcionError.


    7. APARTADO DE EXCEPCIONES

    En esta tabla se describen los códigos de excepción que arroja la aplicación durante el envío de solicitudes al servicio REST.

    • Código 1001: Se presenta cuando el convenio de autenticación no existe aún o este no se encuentra activo
      Descripción error: El convenio de autenticación no existe o no está activo.
    • Código 1002: Se presenta cuando la oficina no existe aún para el cliente o esta no se encuentra asociada al convenio de autenticación.
      Descripción error: La oficina, no existe para el cliente.
    • Código 1003: Se presenta cuando el producto no existe aún o este no tiene relación con la oficina.
      Descripción error: El producto, no existe para el cliente.
    • Código 1004: Se presenta cuando el tipo de identidad no existe aún o este no tiene relación con el tipo de identidad configurado.
      Descripción error: El tipo de identidad para la máquina, no existe.
    • Código 1005: Se presenta cuando el nombre de la maquina no tiene relación alguna con la oficina configurada.
      Descripción error: La máquina, no pertenece a la oficina.
    • Código 1006: Se presenta cuando el nombre de la maquina no tiene relación alguna con el cliente configurado. 
      Descripción error: La máquina, no existe para el cliente.
    • Código 1007: Se presenta cuando la maquina ingresada para la consulta de una solicitud especifica no es encontrada durante la validación de la petición al servicio REST. 
      Descripción error: La máquina ingresada para la consulta no existe.
    • Código 1008: Se presenta cuando el cliente no existe en la base de datos o este se encuentra en estado “Activo”.
      Descripción error: El cliente no existe o no está activo.
    • Código 1009: Se presenta cuando el tipo de documento no concuerda con el que se configuro en el convenio de autenticación 
      Descripción error: El tipo de documento, no es válido para el convenio.
    • Código 1010: Se presenta cuando el tipo de documento no existe en la base de datos.
      Descripción error: El tipo de documento, no existe.
    • Código 1011: Se presenta cuando, durante la creación o actualización de una solicitud se presenta un error de origen indeterminado.
      Descripción error: Error al crear o actualizar la solicitud.
    • Código 1012: Se presenta en el momento en el que se desea cancelar la solicitud, pero esta ya fue usada es decir cambio su estado a un estado diferente de “CREADA”, en cuyo estado debe encontrarse la solicitud para poder ser cancelada correctamente.
      Descripción error: La solicitud, está siendo o ya fue utilizada y no se puede cancelar.
    • Código 1013: Se presenta cuando, el id de la solicitud suministrado en la petición no se encuentra relacionado con el cliente o este no existe en la base de datos Descripción error: La solicitud, no existe para el cliente.
    • Código 1014: Se presenta cuando, el estado del proceso no existe en la base de datos. 
      Descripción error: El estado no existe.
    • Código 1015: Se presenta cuando, el resultado del proceso no existe en la base de datos.
      Descripción error: El resultado no existe.
    • Código 1016: Se presenta cuando, la petición no cuenta con registros del proceso en la base de datos.
      Descripción error: No existen procesos para la solicitud.
    • Código 1017: Se presenta cuando, el convenio ingresado en la petición no se encuentra registrado en la base de datos.
      Descripción error: El cliente aún no tiene configurado ningún convenio.
    • Código 1018: Se presenta cuando, en la consulta de peticiones por maquina no se encuentran solicitudes relacionadas.
      Descripción error: No se encontraron solicitudes.
    • Código 1019: Se presenta cuando, el cliente no se encuentra en estado “Activo”.
      Descripción error: El cliente no se encuentra activo.
    • Código 1020: Se presenta cuando, el cliente no se encuentra registrado en la base de datos.
      Descripción error: El cliente no existe en la base de datos.
    • Código 1021: Se presenta cuando, la solicitud o petición no existe en la base de datos.
      Descripción error: La solicitud o petición no existe.

    6. CONTROL DE CAMBIOS

    VERSIÓN FECHA DESCRIPCIÓN
    1   Creación del documento.

    7. 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