Manual - Administrador 10 : Apis rest

Este atributo de comunicación mediante API REST abre oportunidades para la colaboración y la interoperabilidad, permitiendo a la SVE expandir su funcionalidad al interactuar de manera eficaz con otros sistemas externos de acuerdo a lo que configures, selecciona la opción crear.

Diligencia los siguientes campos:

Nombre: Nombre que va caracterizar al Api en la SVE

Url: Enlace donde se va a conectar

Método: En este campo selecciona de la lista el método por el que se va a conectar la Api, que puede ser: HEAD, DELETE, POST, GET, PUT O PATCH.

Concepto seleccionado: En este campo selecciona un concepto de la SVE.

Descripción: este campo es opcional.

Cabecera (Headers): Información para la conexión a la API: debes asignar las llaves y sus valores. Con la opción del círculo que tiene un +, puedes agregar más llaves.

Parámetros de entrada (Body)

Parámetros de salida: Resultados de la conexión por medio de la Api y que se verán representados en los atributos personalizados, elije si el formato de salida es un JSON o JSON Array.

JSONArray: Es un conjunto de JSON que mostrará la misma cantidad de propiedades que contenga este.

En la columna “Nombre” puedes ir agregando las propiedades de acuerdo a la respuesta que sepas que se va a obtener del JSON, En la columna“Asigna valor en” encontrarás los atributos personalizados del concepto que seleccionaste en el campo anterior llamado “Concepto seleccionado”

Al seleccionar "variable" en el campo "Concepto relacionado" dentro de los parámetros de salida, al elegir la opción "Asignar valor" en la lista, se presentarán, junto a los atributos personalizados, estos campos que son propios del sistema como: Valor del indicador - Valor de la Meta del indicador - Fecha del valor del indicador y Comentario del valor.

Si eliges un JSONArray es obligatorio que marques ¿cual es la clave única de integración? que es la que se utiliza para consultar la información al resultado, de acuerdo a esto se van a llenar los atributos personalizados.

Estos parámetros proporcionan una manera clara y estructurada para poder interactuar con la API REST, y los definen los proveedores del Api y desde la web se pasan los parámetros que sean necesarios para completar la data que necesita la API.

Cuando el Agente “Sincronizador de datos con fuente Apis Rest” se ejecute, el sistema se conectará al Api y estos campos que son propios del sistema y los los atributos personalizados del concepto se llenarán con los valores correspondientes, permitiendo visualizar la variable esporádica y su meta desde la gráfica.