La API del ERP no está preparada, de forma estándar, para la gestión de objetos del ERP. Es decir, no existe una configuración prestablecida que permita consultar o crear objetos o colecciones del ERP.
Lo que sí permite es programar todo lo necesario, de forma personalizada, para publicarlo y poder consumirlo por cualquier aplicación externa que se conecte a la API siguiendo los estándares de comunicación explicados en la presente documentación.
En esencia se deben tener en cuenta los siguiente puntos:
Token (JWT)
Cualquier consulta a la API requiere de un login previo para la obtención de un Token (JWT Bearer) que se debe de pasar como parte de la misma. Para crear este Token es necesario un empleado del ERP con login de base de datos puesto que usar la Tabla Ahora_Sesion para contextualizar todas las llamadas a base de datos.
Desde Swagger se puede utilizar el método Token para su obtención.
Procedimientos
Si se quiere una funcionalidad específica como por ejemplo crear un pedido, será necesario crear un procedimiento personalizado pPERS con todos los pasos necesarios (y restricciones que ya gestiona el ERP) y publicarlo en la API añadiéndolo a la tabla API_Exec. De esta forma el procedimiento será consumible desde la API.
Se puede seguir, como guía de desarrollo, cualquier procedimiento pTPV o pB2B de la base de datos estándar ya incluidos en API_Exec.
En caso de tener activo el proceso, el campo CreateHelp a 1, las cabeceras correctamente configuradas y ejecutado el procedimiento de generación de ayuda (revisar punto Swagger al final del presente artículo), se puede utilizar swagger para su testeo desde el controlador EXEC.
Vistas
Las vistas y tablas sí se pueden consultar directamente si se asignan a las tablas API_List y API_List_Columns. Estas tablas controlan qué vistas/tablas y qué campos de las mismas son accesibles desde la API.
En caso de tener activo el proceso, el campo CreateHelp a 1, las cabeceras correctamente configuradas y ejecutado el procedimiento de generación de ayuda (revisar punto Swagger al final del presente artículo) , se puede utilizar swagger para su testeo desde el controlador LIST.
Swagger
Si se desea usar swagger para probarlos, se tienen que precargar en las tablas API_Help para que la API sea capaz de generar, de forma dinámica, la estructura necesaria para las pruebas. Estas tablas se rellenan usando la información de las cabeceras descriptivas (comentarios) de los procedimientos y vistas. Para rellenar estas tablas se debe ejecutar, manualmente, el procedimiento AhoraAPI_CreateHelp
Retorno
Los datos devueltos por las llamadas de la API están encapsulados en un objeto concreto (API/API-Response) con una estructura definida que no es posible cambiar y a la que se deben adaptar las aplicaciones que consuman estos métodos.
¿Le ha sido útil este artículo?
¡Qué bien!
Gracias por sus comentarios
¡Sentimos mucho no haber sido de ayuda!
Gracias por sus comentarios
Sus comentarios se han enviado
Agradecemos su esfuerzo e intentaremos corregir el artículo