Innovaciones, Optimizaciones y Nuevas Funcionalidades del Ecosistema AS2
Manual de Procedimientos para Mejoras y Actualizaciones
Ecosistema AS2
Este manual documenta de manera detallada los procesos de cambio, optimización o actualización implementados en las soluciones del Ecosistema AS2.
CAMBIOS, MEJORAS O ACTUALIZACIONES
SISTEMA: AS2 ERP
ANTECEDENTES
Actualmente, el sistema AS2 cuenta con una API destinada al consumo de datos por parte de las bodegas, la cual dispone de documentación accesible a través de Postman. Sin embargo, con el objetivo de mejorar la accesibilidad, estandarización y mantenibilidad de la documentación, se plantea incorporar documentación basada en Swagger (OpenAPI). Esta integración permitirá visualizar la documentación técnica directamente desde el sistema AS2, facilitando así su consulta por parte de los desarrolladores e integradores externos, y promoviendo una mejor comprensión de los servicios disponibles en la API.
OBJETIVOS
· Desarrollar un módulo dentro del sistema AS2 que integre la visualización de la documentación Swagger desde la interfaz del sistema, incorporando control de acceso por roles para garantizar que solo los usuarios autorizados puedan acceder y gestionar dicha documentación técnica.
· Incorporar la documentación de la API actual en formato Swagger (OpenAPI) para facilitar su lectura, comprensión y mantenimiento.
· Optimizar la experiencia del usuario técnico, proporcionando una interfaz centralizada y actualizada que permita consultar fácilmente los endpoints, parámetros y respuestas de la API, y que a su vez facilite la integración de servicios externos o nuevos módulos mediante una documentación clara y estructurada.
· Promover la estandarización y buenas prácticas en la documentación de APIs dentro del ecosistema del sistema AS2.
DESARROLLO
Configuración Inicial
Se crea un nuevo proceso llamado documentación donde se va a encontrar todos los endpoints respecto a consumo de bodega, este proceso se debe de asignar en la organización en /paginas/seguridad/asignarProcesosOrganizacion.jsf y este proceso se llama API Rest
Luego asignar al rol a usarse este nuevo proceso en /paginas/seguridad/rol.jsf
Funcionalidad
En este proceso nuevo /paginas/documentacion/apiRest.jsf se le presenta la documentación de las APIS de consumo de bodega y de ingreso al API en donde en esta misma pantalla podrá probar dichos servicios sin la necesidad de conectarse a un software de consulta de APIs como se detalla a continuación:
API USUARIO
Estos endpoints nos servirá para ingresar y generar el token respectivo para el uso del API de consumo de bodegas.
Para poder ingresar a las APIS primero usar el endpoint llamado obtener-token
Ingresar los datos correspondientes de este endpoint y al realizarle la consulta respectiva genera un token
Este token se debe ubicar en el apartado authorize
Una vez puesto esta información del token de autorización vamos a verificar que el token generado ese correcto con el endpoint llamado validar Token
Si el token está correcto la respuesta le dará true
Con esto ya se puede usar sin problemas los endpoint de movimiento inventario(Consumos de Bodega)
API MOVIMIENTO INVENTARIO
En este grupo de endpoints están los servicios que nos permitirá lo siguiente:
· crear-consumo-bodega
· anular-consumo-bodega
· crear-movimiento-inventario
· anular-movimiento-inventario
· Obtener-lista-motivo-ajuste-inventario
Cada endpoint está el ejemplo del json a usarse para crear el servicio que necesita