Manual - Administrador 10 : Atributo personalizado Api 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 atributos personalizados y al cargar la ventana elige el botón crear, luego selecciona el atributo API REST, diligencia los campos como la

Paso a paso de la configuración API REST en la SVE

1. Revisar la Documentación de la API

Antes de configurar, identifique en la documentación del servicio:

• URL: ¿Cuál es la URL de acceso?
  Ejemplo: https://api.dolar-colombia.com

• Parámetros de entrada: ¿Qué datos necesita la API?
  Ejemplo: fecha, moneda.

• Parámetros de salida: ¿Qué datos retorna? Ejemplo: valor_dolar, ultima_actualizacion.

• Método HTTP: GET, POST, etc.

• Formato del cuerpo (Body): JSON, XML, o formulario.

Ejemplo:
Supongamos que usamos la API pública para consultar el precio del dólar en Colombia. Su documentación indica:

• URL: https://www.datos.gov.co/resource/32sa-8pi3.json

• Método: GET

• Entrada: $limit=1.

• Salida: [{"valor": "4169.47","unidad": "COP","vigenciadesde": "2025-05-22T00:00:00.000", "vigenciahasta": "2025-05-22T00:00:00.000"}].

2. Probar la API en Postman

Valide que el servicio funciona a través de la herramienta Postman:

1. Abra Postman.

2. Ingrese la URL: https://www.datos.gov.co/resource/32sa-8pi3.json.

3. Seleccione GET.

4. Haga clic en Send.

5. Verifique la respuesta. Si es 200 OK con datos en formato json, ¡listo!

3. Configurar en la Aplicación

Luego de tener definidos los parámetros de la API Rest, es momento de configurar en la SVE. Ingrese a la sección de atributos personalizados del módulo que desee, en la Figura 1 se ilustra cómo ingresar en el módulo de Indicadores.

A continuación se describen los datos de configuración:

Etiqueta: Define el nombre que se visualizará al editar o explorar el concepto para el cual se está creando este atributo.

Ayuda: Puedo ingresar un texto guía que podrán visualizar los usuarios cuando ingresan información al crear, editar o explorar el concepto para el cual aplica.

Orden en la pantalla: Indica la posición de este atributo en la opción explorar y editar de acuerdo al concepto para el cual aplique.

Activo en el sistema: Es un campo informativo. Indica si el atributo personalizado puede ser usado en las pantallas de edición y exploración del concepto. Al crear un atributo, su valor predeterminado es Sí.

Depende de: Es un campo opcional que se debe usar sólo si se desea que el atributo editado dependa de otro. De ser así, debe elegir el atributo que será superior entre los atributos tipo lista (única) que se muestran como opciones en este campo. 

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.

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 salida: Agrega un nombre y selecciona de la lista el atributo al que se le va asignar el valor

En la Figura 2 se muestra el ingreso de los datos de configuración.

Figura 2 Parámetros de configuración de atributo API Rest

A. Parámetros Básicos

• URL: Ingrese el enlace de acceso al servicio API Rest.
  Ejemplo: https://www.datos.gov.co/resource/32sa-8pi3.json.

• Método: Seleccione el tipo de método requerido por el proveedor del servicio.
  Ejemplo: GET.

B. Parámetros de Cabecera (Headers)

Defina los parámetros del header de la petición de la forma:

Llave -> Valor

El valor puede ser estático definido en la configuración o dinámico relacionando a un atributo personalizado o una fuente previamente cargada en la SVE como API Rest.

C. Parámetros de Entrada (Body)

Defina los parámetros de entrada según lo requiera la API Rest. Se pueden definir de la forma Llave -> valor, o creando manualmente la estructura Json seleccionando la opción “Datos sin procesar” como se muestra en la Figura 3.

Figura 3. Definir los parámetros de entrada manualmente con estructura json.

C. Guardar Configuración

1. Revise campos obligatorios ([*]).

2. Haga clic en Guardia para guardar.

D. Probar conexión en Previsualización

Ingrese a Previsualizar y realice la prueba de conexión como se ilustra en la Figura 4.

Figura 4. Ejecución de Consumir API para verificar que funciona correctamente

NOTA: Para configurar una fuente de tipo API Rest ingrese al Módulo Administrador como se indica en Apis rest.