1. Introducción
Prevengos dispone de un Servicio Web API a través del cuál se puede habilitar el acceso a algunos datos de Prevengos desde cualquier ubicación. Este servicio dispone de varias funciones, una de ellas permite la introducción de datos a Prevengos desde un fichero con formato XML con una estructura concreta, mientras que existen varias funciones de consulta con las que se podrá extraer información de la base de datos de Prevengos, como pueden ser datos de empresas, contratos o formación a trabajadores.
Estas nueva opciones requieren de una configuración en Prevengos que pasaremos a explicar en este Manual. Toda esta información se ha agrupado en una nueva herramienta accesible desde la pantalla principal del programa, tal y como podemos ver en la siguiente captura:
2. Configuración
Antes de proceder a la configuración del servicio deberan haber instalado previamente el Servicio WEB API, instalador que tendrán disponible en el área cliente de www.prevengos.com si tienen contratado dicho módulo.
La configuración se encuentra en la pantalla principal de Prevengos, en el desplegable 'Configuración', pulsando sobre la opción 'API Web Service de Prevengos (WSAPI)'. Una vez accedan a la configuración, se mostrará una ventana similar a la siguiente imagen:
Dentro de esta ventana tenemos que habilitar el acceso a la propia API, para ello marcaremos el check Habilitar acceso a la API por parte de terceros. Una vez habilitado el servicio podrán pasar a las opciones de configuración de la misma
El siguiente punto, "Configuración de seguridad. Direcciones IP permitidas" nos servirá para controla y restringir el acceso a la API mediante el permiso a IP públicas desde las que se podrá llamar a la API. Encontramos 3 opciones disponibles:
- No limitar. Permitir cualquier comunicación: De esta manera no se realizará ningún bloqueo o filtro en las IPs públicas que accedan a la API, pudiendo realizar llamadas desde cualquier IP.
- Sólo permitir las direcciones IP indicadas en la lista: Para ello disponemos del campo inferior donde añadir las direcciones IP a las que queremos permitir el acceso, de tal manera que se denegará el acceso a cualquier dirección IP que no esté dentro de la lista. Esta opción es la mejor cuando queremos permitir el acceso a la API desde una IP determinada (su propia oficina, por ejemplo).
- Denegar las solicitudes de las direcciones IP indicadas en la lista: Usaremos el mismo listado de IP indicado en el punto anterior, pero en este caso se permitirá el acceso a la API a cualquier IP que no esté dentro de esta lista. Ideal si detectamos el ataque o intento de intrusión desde una IP determinada y queremos bloquearla.
Sobre el listado de IP, la aplicación permite añadir una IP determinada o un rango de IP, tal y como se explica en la ventana donde se establecen:
Pasamos ahora a la segunda pestaña presente en la ventana de configuración, denominada Usuarios de la API, similar a la siguiente imagen:
Dentro de este apartado vamos a establecer los usuarios que van a tener acceso a la API, para ello disponemos de opciones para crear, editar y eliminar usuarios dentro del desplegable Usuarios, al igual que para activar/desactivar usuarios ya existentes. A la hora de crear usuarios nuevos, se mostrará la siguiente ventana.
El primer campo, denominado Login, lo usaremos para indicar el usuario que se usará para conectar con la API.
Seguidamente podemos establecer la contraseña de acceso para ese usuario, en el campo Password. Prevengos permite que se genere una contraseña aleatoria mediante el botón "Generar contraseña aleatoria", por defecto se asignará una contraseña 'fuerte'. Además, dentro de este bloque, podemos establecer una descripción sobre el usuario, o marcarlo como usuario desactivado cuando sea necesario (la misma opción de activar/desactivar que veíamos en el desplegable Usuarios de la ventana anterior).
Para cada usuario podremos limitar las empresas a las que puede acceder, esto lo realizaremos desde el apartado de 'Configuración de seguridad' de cada usuario. De tal manera, podemos no establecer ningún tipo de limite, con lo que podrá acceder a todas las empresas, o indicar a cuales puede acceder. Esta opción exige añadir dichas empresas en la parte inferior desde el desplegable "Empresas", teniendo en cuenta que aquellas empresas que no estén en el listado estarán bloqueadas para el usuario que estamos creando.
Por último pasamos a la pestaña Funciones con Permiso del usuario que estamos creando, donde podemos establecer los permisos que va a tener con la aplicación, tal y como podemos ver en la siguiente imagen:
Encontramos 5 permisos relacionados con las funciones que podrá ejecutar el usuario al llamar a la API. Estas funciones pueden ser de importación de datos o de exportación de datos. Si habilitamos la columna 'RW', estaremos permitiendo al usuario el uso de esa función, mientras que si usamos la columna 'D', estaremos denegando al usuario el uso de esa función.
La función de 'Importación de datos XML', permitirá al usuario importar datos a Prevengos a través de un archivo con formato XML. Si el usuario no tiene este permiso habilitado y llama a esta función, la API devolverá un mensaje de acceso denegado.
El resto de las funciones son todas de consulta, es decir, las llamadas a la API con estas funciones devolverán datos almacenados en Prevengos de Empresas, contratos y trabajadores en formación. Se usarán para extraer datos de Prevengos (función GET).
Aceptaríamos ambas ventanas con lo que tendríamos creado el usuario con la configuración establecida y podremos lanzar las consultas mediante la API