Saltar a contenido

Configuración de External API

Este módulo de PowerStudio Scada Wave permite conectar el programa con servicios externos mediante APIs que intercambian datos en formato JSON, facilitando la integración con plataformas, sistemas o dispositivos de terceros.

Importante

El módulo External API solo funciona con APIs con formato JSON.

A continuación se explica como:

  • Utilizar como ejemplo la API JSON de Visualcrossing.
  • Crear una variable calculada forzable en PowerStudio Scada Editor.
  • Configurar el módulo External API.

Ejemplo con la API JSON de Visualcrossing

Utilizamos como ejemplo la web gratuita de Visualcrossing para hacer las pruebas con nuestra herramienta External API.

Si no estamos dados de alta en esta web deberemos crear una cuenta para utilizar la API.

Una vez dados de alta en la página web hay que ir a la sección Query Builder donde seleccionaremos la zona de la cual queremos obtener los datos del tiempo.

Ahora hacemos clic en Build API Query. Esto generará el código en formato JSON que utilizaremos en nuestra API.

Todo el texto que nos devuelve la web será utilizado en el módulo de External API.

Como crear una variable calculada forzable en PowerStudio Editor

Una variable calculada forzable es una variable que se puede sobrescribir con un valor cualquiera. Esto nos servirá para enlazar nuestro módulo External API con esta variable. De esta forma los valores que seleccionemos de la API JSON de Visualcrossing se guardarán en la variable calculada forzable que nosotros configuremos.

Para poder crear una variable calculada forzable debemos:

  • Acceder al programa PowerStudio Scada Editor. Ir al apartado Configurar -> Variables Calculadas y crear el grupo de variables calculadas forzables:

Importante

Es muy importante marcar el check en Guardar. Este tiempo define el periodo con el cual se guardan los valores.

Utilizaremos el mismo tiempo de guardado a la hora de configurar las variables en el módulo External API.

  • Crear la variable calculada con el check de Variable forzable marcado:

Nota

Hay que crear una variable calculada forzable para cada una de las variables de la API que queramos utilizar. Para este ejemplo solo creamos una para la variable de temperatura.

Configurar el módulo External API.

Para crear una nueva conexión API debemos seguir estos pasos:

1- Hacer clic en "Nuevo":

2- Rellenar los 3 campos donde:

  • "Nombre de la conexión": Se escribe nombre que queremos darle a la conexión.

  • "URL de la conexión": Ponemos el Weather API Query URL que nos devuelve la página y que contiene la información de esta API.

  • "Período": Se define el tiempo de guardado de las variables.

Importante

Es muy importante que el Período (minutos) coincida con el tiempo de guardado de nuestras variables calculadas forzables.

Nota

Es posible probar si la API funciona haciendo clic en el icono .

3- Hacer clic sobre la API creada para configurarla:

4- Una vez la API está creada hay que seleccionar las variables que se necesiten. Se debe configurar de la siguiente forma:

  • Hacer clic en "Consultar API":

Una vez dentro, hay que seleccionar la variable o variables que queramos utilizar. Para poder seleccionar las variables deberemos hacer clic sobre cada una de ellas una por una. Una vez seleccionadas hay que hacer clic en "Guardar":

  • Hacer clic en "Seleccionar":

  • Se selecciona el grupo de variables y la variable en concreto donde se quiere guardar el valor:

  • Hacer clic en "Iniciar conexión":

Una vez realizada la conexión se verán los datos de las variables seleccionadas. A parte también es posible ver la fecha en la que se ha realizado la conexión.