Resultado Simplificado Webhook

Para consumir el servicio REST con resultado simplificado WebHook, es necesario hacer un llamado POST, usando una autenticación básica en los “headers” con el usuario y la contraseña proporcionados.

🔗 Endpoints disponibles

POSThttp://localhost:8081/app/webServiceRSWebHook

📦 Estructura JSON

{
  "placa": "HXX005",
  "esConsultaPlus": true,
  "consultarPropietariosAnteriores": true,
  "urlWebhook":"https://urlwebhool.com/"
}

Estructura JSON de Envío

La solicitud al servicio debe enviarse en formato JSON, con los siguientes atributos:

Atributo	Tipo	Descripción
placa	String	Campo que indica la placa del vehículo a consultar.
esConsultaPlus	Boolean	(Opcional) Campo que indica si la consulta sera plus o no. Por defecto su valor es false
consultarPropietariosAnteriores	Boolean	(Opcional) Campo que indica que se consultaran las fuentes configuradas de persona, para todos los propietarios del vehículo, este parámetro viene atado con el parámetro esConsultaPlus. Si el parámetro esConsultaPlus se envía en false y este en true, se cambiará de manera automática a false este campo. Se puede omitir en el body o se puede enviar como false.
urlWebhook	String	Campo que indica URL de la api a la cual se enviara la respuesta una vez terminado el proceso de consulta

🧾 Respuesta

✅ Ejemplo de respuesta (200 OK)

En todos los casos, se retorna una estructura JSON con los siguientes atributos:

{
  "idConsulta": "6819352a2d56fe06e5879fd4",
  "tipoConsulta": "WEB"
}

Estructura JSON de Respuesta enviada a WebHook

En todos los casos, se retorna una estructura JSON con los siguientes atributos:

Atributo	Tipo	Descripción
idConsulta	String	Campo que indica el id de la consulta.
tipoConsulta	String	Campo que indica el tipo de consulta realizada. Ejemplo: WEB, WS, Mobil, etc.
fechaHoraInicio	Timestamp	Campo que indica fecha de inicio de la consulta en formato timestamp de 13 dígitos.
fechaHoraFin	Timestamp	Campo que indica fecha de finalización de la consulta en formato timestamp de 13 dígitos.
correoUsuario	String	Campo que indica el correo del usuario que generó la consulta.
datosConsultados	JSONArray	Campo que indica un arreglo con objetos que contienen los resultados de cada dato consultado. A continuación, se explica en detalle la estructura del objeto.

Estructura JSON del Objeto “datosConsultados” dentro del JSON de Respuesta

Atributo	Tipo	Descripción
idDatoConsultado	int	Campo que indica el identificador único del dato consultado. Sirve para hacer seguimiento ante posibles dudas o errores.
tipoDocumento	String	Campo que indica el tipo de Documento consultado. Ejemplo: Cédula, NIT, etc.
dato	String	Campo que indica el número de documento consultado.
apis	JSONArray	Campo que indica arreglo con objetos que contienen los resultados de cada fuente.

Estructura JSON de una api dentro del JSON de apis

Atributo	Tipo	Descripción
lista	String	Campo que indica el nombre único de la fuente dentro del sistema. Se debe homologar con el listado de fuentes disponibles descrito en el apartado de apis.
tipo	String	Campo que indica agrupación lógica dentro de la aplicación, ejemplo: Información General, Seguridad Social, Fuentes Nacionales, Fuentes Internacionales, PEPS, Noticias, Buscadores, Lista Privadas.
presentaRiesgo	Boolean	Campo que indica si la fuente generó alerta de riesgo.
presentaAdvertencia	Boolean	Campo que indica si la fuente generó advertencia de riesgo. Sólo se incluye si el parámetro SoloRiesgo se envía en false.
error	String	Campo que indica mensaje de error que se incluye únicamente cuando se produjo un error en el origen.