api rest de velneo verp.dl.velneo.com/es/productos/v7/openapps/documentos/velneo_verp_1… · desde...

API REST de Velneo vERP.

Documentación API REST de Velneo vERP ¿Sabes que todas las aplicaciones basadas en Velneo vERP tienen un API REST? Pues así es, simplemente porque has desarrollado una aplicación heredando o personalizando directamente sobre Velneo vERP tu aplicación ya dispone de un API REST que te permite acceder vía HTTP al contenido de todas las tablas, procesos y búsquedas a los que tú quieras dar acceso. ¡¡¡Y sin programar ni cambiar nada en tu aplicación!!! ¿Sabes que puedes hacer al disponer de un API REST en tu aplicación? Disponer de esa tecnología significa que tu aplicación está abierta al mundo y te permite desarrollar a ti o a terceros soluciones basadas en tu aplicación y sus datos como:

- Aplicaciones para dispositivos móviles. - iOS. - Android. - Windows Mobile. - etc.

- Aplicaciones web.

- Tiendas online con Prestashop, Magento, WOOCommerce, etc usando sus APIs. - Conexión con plugins WordPress. - Catálogos de productos, servicios, tarifas de precios.

- Servicios web servidores (para ejecutar desde aplicaciones externas).

- Ejecutar procesos de tu aplicación. - Ejecutar búsquedas complejas que devuelven registros de tu aplicación. - Dar altas, bajas y modificaciones de registros de tablas Velneo de tu aplicación.

- Programar controles de terceros que pueden usar información JSON, XML, etc.

- Controles grid desarrollados en HTML5. - Controles QML. - Gráficos. - etc.

Pol. Ind. A Granxa, Edificio vCenter Rúa D, esquina paralela 3 36400 Porriño (Pontevedra) España

Telf. (+34) 986 93 21 63 [email protected] velneo.es

Velneo, S.A. C.I.F. A36494706 Inscrita en el Reg Mercantil de Pontevedra al tomo 3085, Libro 3085, Folio 90, Hoja PO37578, Inscr 1ª

https://www.prestashop.com/es/

https://magento.com/

https://www.woothemes.com/woocommerce/

https://es.wordpress.com/

mailto:[email protected]

http://velneo.es/


- Programar servicios. - Sincronización de datos entre servidores. - Sincronización de datos entre instancias.

¿Qué pasos tengo que seguir para que mi aplicación desarrollada con Velneo vERP tenga disponible un API REST?

Debes realizar estos sencillos pasos:

1. Instalar la versión de Velneo vERP 19 o superior. 2. Instalar un servidor Apache. 3. Instalar y configurar el componente vModApache 7.19 o superior. 4. Ejecutar Velneo vERP y configurar la seguridad. 5. Probar el API desde Swagger.

El paso 1 simplemente consiste en instalar el fichero de instalación .vin correspondiente a la versión de Velneo vERP 19 o superior utilizando el componente Velneo vAdmin. El paso 2 no se detalla en este documento ya que existe multitud de información en Internet sobre como instalar un servidor Apache, además de que en muchos servicios de Hosting ya está preinstalado y que existen instalaciones para los diferentes sistemas operativas basadas en un sencillo asistente de instalación.





http://velneo.es/


Paso 3. Instalar y configurar el componente vModApache 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. https://velneo.es/info_v7_718_es/velneo_vmodapache_v7/ 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.




https://velneo.es/info_v7_718_es/velneo_vmodapache_v7/


http://velneo.es/


Paso 4. Ejecutar Velneo vErp y configurar la seguridad 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





http://velneo.es/


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.





http://velneo.es/


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.





http://velneo.es/


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.





http://velneo.es/


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





http://velneo.es/


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.

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.





http://velneo.es/


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.





http://velneo.es/






http://velneo.es/


Paso 5. Probar el API desde Swagger ¿Qué es Swagger? 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. La definición swagger es accesible mediante la url de tu instalación https://ejemplo.com/alias/vERP_2_dat_dat/swagger Para poder ver una documentación vistosa de tu API, puedes introducir tu url de definición de swagger en la herramienta 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 del 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 dicho API key




https://ejemplo.com/alias/vERP_2_dat_dat/swagger

http://petstore.swagger.io/

https://github.com/swagger-api/swagger-ui


http://velneo.es/


¿Puedo usar este API REST sin heredar o usar Velneo vERP? 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. Objetos a integrar del proyecto de datos vERP.dat

● Scripts ○ Exportar la carpeta del diccionario de script js/api_rest_v1 que contiene los

scripts: ■ 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.

● Tablas

○ Carpeta Tablas/Configuración ■ API_KEY_W (API keys) ■ API_SEG_W (API seguridad)

● Dibujos

○ Carpeta Dibujos/Tablas/Configuración ■ API_KEY_W (API keys) ■ API_SEG_W (API seguridad)

● Procesos

○ Carpeta Procesos/API REST v1 ■ SWAGGER ■ API_REST_v1





http://velneo.es/


Objetos a integrar del proyecto de aplicación vERP.app

● Carpetas con objetos de interfaz ○ Dentro de la carpeta Configuración copiar la carpeta API keys con todas sus

subcarpetas.

● Opción de menú para ejecutar la interfaz ○ 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.





http://velneo.es/

api rest de velneo verp.dl.velneo.com/es/productos/v7/openapps/documentos/velneo_verp_1… · desde...

Documents