Documentación de la ApiRest
Última actualización
¿Te fue útil?
Última actualización
¿Te fue útil?
Sí, para hacerlo tendrás que integrar en tus proyectos los siguientes objetos que encontrarás en los proyectos de Velneo vERP. Lógicamente debes añadir los objetos del proyecto de datos en tu proyectos de datos y lo mismo con los de aplicación.
Exportar la carpeta de script js/api_rest_v1 que contiene los scripts:
api_rest_funciones_v1.js
swagger.js
v1.js
Se puede importar la carpeta directamente o bien cada uno de los scripts de forma individual. Lo verdaderamente importante es mantener la estructura de carpetas, es decir, que exista la carpeta js y dentro de esta la carpeta api_rest_v1 donde ubicaremos ambos scripts. De esta forma el resto de objetos que hacen referencia a estas ubicaciones serán operativos al pegarlos en nuestro proyecto sin necesidad de revisar sus propiedades.
Exportar el script activarVista.js que está incluido en la carpeta /js/interface/ e importarlo en nuestra aplicación en la misma estructura de carpetas. Este script es necesario para el control de vista activa del menú de API Keys.
Carpeta Tablas/Configuración
API_KEY_W (API keys)
API_SEG_W (API seguridad)
Carpeta Dibujos/Tablas/Configuración
API_KEY_W (API keys)
API_SEG_W (API seguridad)
Carpeta Procesos/API REST v1
SWAGGER
API_REST_v1
Dentro de la carpeta Configuración copiar la carpeta API keys con todas sus subcarpetas.
Para ejecutar la opción de menú que muestra la interfaz de API keys donde se define toda la seguridad debemos lanzar la acción API_KEY_W_MEN es recomendable que esta opción sólo esté disponible para administradores o usuarios avanzados.
Guardar y reiniciar las instancias en el servidor.
La seguridad del API REST está basada en 2 capas actualmente:
Capa 1: clave API key.
Capa 2: configuración de seguridad a nivel de tablas, campos, procesos y búsquedas.
La capa 1 consiste en una clave definible por el programador o el usuario en tiempo de ejecución que se configura desde el menú Supervisor -> API keys.
Al ejecutar esta opción se muestra el formulario de menú de API keys
Podemos crear tantos registros como queramos, en cada registro de API key debemos grabar una descripción y el valor de la clave del API key.
En la pestaña seguridad del API key podremos generar tantos registros como tablas tenemos en nuestros proyectos de datos más un registro para los objetos poder configurar la seguridad de los procesos que no tienen tabla destino declarada.
En el formulario se puede configurar con el check si es para procesos sin tabla destino, una vez marcado sólo nos aparecerá la pestaña de procesos.
En la parte superior izquierda tenemos 4 checks para configurar si este API key soporta los métodos GET, PUT, POST y DELETE.
En caso de no marcar el check sin tabla nos aparecerán 3 pestañas para configurar la seguridad de campos, procesos y búsquedas.
Para seleccionar un proceso, lo que debemos seleccionar en los combo boxes son el proyecto de datos donde está tabla de destino y la tabla de destino.
En el caso de configurar una tabla debemos seleccionar un proyecto de datos de todos los cargados en ejecución y una vez seleccionado el proyecto podremos elegir la tabla sobre la que vamos a configurar la seguridad.
De igual modo podemos configurar en la parte superior derecha los métodos aceptados para dicha tabla (GET, PUT, POST y DELETE).
Las tres pestañas de seguridad de campos procesos y búsquedas tiene la misma funcionalidad y usabilidad.
Por defecto el API REST no permitirá devolver información de un campo, proceso o búsqueda que tengan marcado el estilo privado.
En la de campos tenemos un check que nos permite indicar si queremos que todos los campos de la tabla que no sean privados estén disponibles para el API. Conviene marcarlos si queremos que estén accesibles la mayoría de campos, en ese caso los campos que seleccionemos en la rejilla inferior serán excluidos del retorno de información que genere el API.
Los campos que devolverá el JSON al ejecutar el proceso son los que se marquen en la pestaña campos del API, que no hay que programar nada en el proceso.
Si queremos dejar accesible un número pequeño de campos es mejor no marcar el check y hacer la selección de los campos accesible. En definitiva lo que se trata es de seleccionar de la lista el menor número de elementos utilizando el check para dicho fin.
Los procesos y las búsquedas funcionan igual con un check que permite seleccionar todas excluyendo las seleccionadas o solo incluir las seleccionadas si no marcamos el check.
Para poder acceder al API REST se usa el componente vModApache que permite que el servidor web Apache pueda servir de forma automática la documentación swagger y el API REST de tu aplicación.
La instalación lleva mismos pasos que la instalación habitual de vModApache.
Es extremadamente importante que configures el Apache en HTTPS con un certificado. De esta forma evitas que la información http viaje en plano y sea accesible por terceros.
Añadir una directiva location o virtualhost para conectarse a la instancia de la aplicación en el fichero de configuración de Apache. Ejemplo:
Una vez aplicadas las configuraciones, reiniciamos el servidor Apache.
Swagger es estándar para definir interfaces de API REST que permite que tanto personas como máquinas puedan entender y comprender las capacidades de un servicio sin acceder al código fuente o una documentación específica. Actualmente swagger forma parte de la especificación OpenApi.
El API REST de Velneo genera dinámicamente un fichero de definición swagger del API disponible en tu aplicación.
Para acceder Swagger usa la siguiente url:
Si estás usando la versión anterior de la API rest, entonces has de usar esta otra URL:
https://demoapi.velneo.com/swagger_old/
Verás que al cargar la página propone la url de acceso a la instancia web que tenemos de la demo de Velneo vERP (https://demoapi.velneo.com/verp-api/vERP_2_dat_dat/swagger) y nos pide que introduzcamos la APIKey. En el caso de la demo de vERP ésta es: api123
Así ya podrás comprobar cómo funciona.
Para poder ver una documentación vistosa de tu API, puedes introducir tu url de definición de Swagger en la URherramienta swagger ui.http://petstore.swagger.io/, en la casilla superior y pulsar explorar. Si quieres acceder desde una red privada puedes descargar la herramienta swagger ui a tu ordenador y generar la documentación de tu API en local https://github.com/swagger-api/swagger-ui
Desde swagger ui, no solamente puedes ver la documentación de la API, sino que podrás probar los distintos recursos y testear contra los datos reales de las aplicaciones.
Recuerda introducir el API key que has puesto en vERP en la página de Swagger UI para poder simular las mismas opciones que se puedan hacer con dichao API key.
Doble factor de validación
Tras mostrarse la interfaz de Swagger, es necesario conocer el nombre de la API y asignarla a la variable “api_name”. Una vez comprobada su validez, se mostrarán los recursos disponibles y será necesaria la validación del “api_key” para usarlos.
Información del API Rest configurable
Los texto que se muestran en la pantalla inicial del API Rest, son obtenidos de la pestaña “Comentarios” del proyecto.
Una vez validado con un api_name, la información será sustituida por la que exista en las observaciones de la tabla del API.
Información de las tablas configurable
La información adicional mostrada en las tablas, procesos y/o búsquedas es obtenida desde el campo “Comentarios” de cada tabla.
Métodos append, cross y delete para los filtros
El filtrado por defecto realiza un {cross} (cruce de registros). Por ejemplo, si filtramos por los artículos que contengan la palabra “cámara” y como segundo filtro le asignamos que la familia sea “A01”, nos devolverá las cámaras cuya familia sea A01.
También es posible añdair registros en filtrado, usando el método {add}. Para que en el mismo ejemplo sume los registros que contengan la palabra cámara a los que contengan la familia A01, sería:
También es posible quitar registros en el filtrado, mediante el método {delete}. Para que en el mismo ejemplo quite los registros que contengan la familia A01 dejando solo los que contengan la palabra “cámara” y no sean de la familia A01.
Agrupamiento de recursos por tags
Todos los recursos mostrados por el API Rest (tablas con sus métodos, procesos y búsquedas) son agrupado por nombre de tabla y pueden mostrarse y/o ocultarse.
Interfaz
La interfaz permite añadir mediante botones más usables los parámetros de búsqueda, nuevos botones para copiar la llamada y la respuesta del API, …
Ejemplos:
Url Swagger vERP Demo: (clave api= api123)
https://demoapi.velneo.com/swagger/
Url Swagger para el registro de tu propia documentación:
Todos los artículos:
https://demoapi.velneo.com/verp-api/vERP_2_dat_dat/v1/art_m?api_key=api123
Todos los artículos pero mostrando los campos id, name, dsc:
https://demoapi.velneo.com/verp-api/vERP_2_dat_dat/v1/art_m?fields=id%2Cname%2Cdsc&api_key=api123
El artículo con id=1
https://demoapi.velneo.com/verp-api/vERP_2_dat_dat/v1/art_m?filter%5Bid%5D=1&api_key=api123
Los artículos con id 1, 3 y 5
Todos los clientes:
Si bien Swagger requiere CORS ((Cross-Origin-Resource-Sharing) si usamos el API Rest de Velneo vERP no es necesario activarlo en Apache, pues las propias cabeceras de nuestra API Rest ya lo activan directamente.
