Servicios de Parsable
1. Descripción
La información proveniente de Parsable es procesada mediante Apache NiFi y almacenada en diferentes objetos de la base de datos omnicanal, de acuerdo con el tipo de información.
La integración se encuentra organizada en tres grupos principales:
- Jobs: información relacionada con los trabajos ejecutados en Parsable.
- Deviations: información relacionada con las desviaciones detectadas durante la ejecución de los trabajos.
- Imágenes: información relacionada con las imágenes asociadas a los registros de Parsable.
Los Servicios de Parsable son servicios de integración que permiten procesar y exponer información proveniente de la plataforma Parsable.
2. Servicios de Parsable
| No. | Origen | Catálogo | Descripción |
|---|---|---|---|
| 1 | Jobs | Visitas por Día / Status | Muestra el total de los trabajos realizados por estatus de las visitas al día. |
| 2 | Jobs | Visitas por Asesor / Día | Muestra el total de los trabajos realizados por asesor al día. |
| 3 | Jobs | Tiempo Visita | Muestra el tiempo registrado para las visitas realizadas en Parsable. |
| 4 | Jobs | Resumen Tiempo Visita | Genera un resumen del tiempo empleado en las visitas realizadas en Parsable. |
| 5 | Deviations | Detalle Desviaciones | Muestra el detalle de las desviaciones. |
| 6 | Deviations | Desviaciones | Muestra el total de las desviaciones realizados por día. |
| 7 | Deviations | Información Grafico | Información del Grafico de Desviaciones. |
| 8 | Deviations | Resumen Desviaciones | Genera un resumen de las desviaciones realizadas en Parsable. |
| 9 | Deviations | Total Desviaciones | Total de las desviaciones realizados y principal. |
| 10 | Imagenes | Recuperación de Imagenes | Recupera de Alfresco la Imagene correspondiente al ID. |
Estas funciones encapsulan las reglas de negocio para generar información de Parsable y son expuestas mediante servicios REST a través de la API de Catálogos.
2. Arquitectura de la solución
El flujo general de información es el siguiente:
3. Componentes de la solución
| Componente | Descripción |
|---|---|
| Parsable | Plataforma origen de la información de los catálogos. |
| Alfresco | Repositorio documental y gestor utilizado para el almacenamiento y administración de imágenes. |
general_catalogs | Esquema donde se encuentran las funciones e información de Parsable. |
alp_cat_parsable_jobs | Tabla de Omnicanal donde se almacena la información proveniente de Parsable de Jobs. |
alp_cat_parsable_deviations | Tabla de Omnicanal donde se almacena la información proveniente de Parsable de Deviations. |
alp_cat_parsable_alfresco | Tabla de referencia que asocia los registros de Parsable con sus respectivas imágenes almacenadas en Alfresco. |
| Funciones PostgreSQL | Procesan la información de Parsable y generan los datos requeridos. |
| API de Catálogos | Expone las funciones mediante servicios REST. |
| Keycloak | Servicio utilizado para la autenticación y generación del token de acceso. |
4. Autenticación
Para consumir los servicios de la API de Catálogos es necesario obtener previamente un token de acceso mediante el servicio de autenticación de Keycloak.
La autenticación se realiza mediante el flujo password, enviando las credenciales del usuario y la información del cliente configurado en el proveedor de identidad.
Si quieres una presentación aún más compacta y visual, puedes usar una tabla general:
4.1. Información del servicio de autenticación
| Elemento | Valor |
|---|---|
| 🌐 Endpoint | /realms/Alpura/protocol/openid-connect/token |
| ⚙️ Método HTTP | POST |
| 📦 Content-Type | application/x-www-form-urlencoded |
4.2. Parámetros de autenticación
| Parámetro | Descripción |
|---|---|
grant_type | Tipo de flujo de autenticación utilizado para obtener el token. |
client_id | Identificador del cliente configurado en Keycloak. |
client_secret | Secreto asociado al cliente. |
username | Usuario utilizado para realizar la autenticación. |
password | Contraseña del usuario. |
Los valores sensibles deben gestionarse mediante variables de entorno o un administrador de secretos.
5. Servicios de Catálogos
Para facilitar la integración y el mantenimiento, todos los endpoints de la API de Catálogos comparten una dirección base común. Las consultas específicas se realizan modificando el catálogo de destino en la URL.
5.1. Información de los Servicios Jobs
- Visitas por Día / Status
- Visitas por Asesor / Día
- Tiempo Visita
- Resumen Tiempo Visita
| Elemento | Valor |
|---|---|
| 🌐 Endpoint | /gc/v1/api/v1/catalogo/funcion/cat_parsable_visitas_dia_status |
| ⚙️ Método HTTP | POST |