gladtolinkblog

Configurar una integración de tipo «Lista Externa»

Alvaro Cabrera

Alvaro Cabrera

Share on linkedin
Share on facebook
Share on twitter
Share on google
Share on whatsapp
Descubre qué es y cómo configurar todas las opciones de las integraciones de tipo "Lista Externa"

Una integración de tipo «Lista Externa» es un puente que utiliza CaptureData para pedir un listado de datos a APIs externas. Este puente se configura desde gladtolink.

Para crear una integración de lista externa, dirigiete a la pantalla de integraciones, y crea una nueva. En el apartado «Servicio» busca y selecciona la opción «Lista Externa».

Configuración de la llamada.

El primer paso para realizar este tipo de integración es configurar la llamada y los parámetros que vas a enviar al servidor para mostrarle qué datos tiene que enviarte.

Configuración básica.

El primer apartado que debemos configurar es «Configuración básica». En este apartado se encuentran los elementos indispensables para realizar la llamada.

Ruta: Este parámetro corresponde a la ruta o URL de la API donde se desea consultar los datos.

Tipo : Corresponde al tipo de llamada que se usará para enviar los datos, puede ser de tipo GET, POST o PUT. En caso de las POST y PUT hay que definir adicionalmente otro parámetro, el «Tipo de envío».

Tipo de envío : Corresponde al tipo de parámetros adicionales que vamos a enviar dentro del cuerpo de la llamada.

Configuración de página y búsqueda.

Este apartado corresponde a la configuración especifica para listas externas. Sirve para definir los parámetros relacionados con el paginado y el filtro de resultados.

En caso de que la API a la que estés solicitando datos tenga soporte para paginado o para filtrado, debes especificar el nombre del parámetro y en qué parte de la llamada se encuentra (Body, Header o Query).

Nombre del parámetro de la página : Este parámetro corresponde al nombre con el que la API identifica la página solicitada. Se requiere que la API tenga soporte para paginado.

 Este parámetro será un número natural que empezará en 1 y se irá incrementando cuando tengan que solicitarse posteriores páginas.

Nombre del parámetro de la búsqueda : Este parámetro corresponde a la cadena de texto que el usuario puede introducir para filtrar los elementos y cuya implementación viene determinada por el servidor que recibe las peticiones. Por usabilidad, recomendamos que esta sea una búsqueda por texto plano.

Elementos por página : Este parámetro corresponde a la cantidad de elementos que se espera que la API devuelva en su respuesta, con un mínimo de 10 y un máximo de 100 elementos en cada petición de página.

Respecto al paginado de elementos, debemos tener en cuenta lo siguiente:

  1. Si el servicio devuelve el número de elementos por página especificados, al llegar al final de la página se ejecutará la siguiente petición, incrementando el parámetro page en 1
  2.  Si el servicio devuelve menos elementos de los esperados o cero, se mostrarán estos elementos y se entenderá que se ha llegado a la última página, por la que ya no se ejecutarán más peticiones
  3. Si el servicio devuelve más elementos de los especificados estos no serán procesados y se alertará al usuario

Configuración de la respuesta.

Tras configurar la llamada, el siguiente paso es configurar cómo vas a tratar los datos que envíe la API objetivo.

Respuesta JSON Array : En este apartado debes agregar un objeto de muestra de la respuesta que se va a recibir (en formato JSON Array) para poder procesar los datos desde Gladtolink. 

En función de como estén formateados los datos que devuelve el servicio origen, debes subir un ejemplo con el array que contiene los elementos a procesar de nuestra respuesta. Puede ser algo parecido al siguiente:

Los valores que contenga cada atributo son indiferentes, pero deben contener un valor del tipo deseado (Int, string…), ya que lo importante es identificar los atributos que contrendrá el objeto, el nombre y el tipo de los mismos.

Formulario de retorno.

En este aparatado se configura cómo se van a enlazar o mapear los datos  obtenidos de la API. Primero selecciona un formulario, donde se guardarán dichos datos.

Estatus : En este campo se guardará el resultado de la conexión.

Mensaje, en caso de fallo : Si se diera el caso de que no se puede acceder correctamente a los datos solicitados, el servidor retornará un mensaje de error, que se guardaría en este campo.

Nombre del atributo : En caso de que la API retorne directamente objeto (no array), debe especificarse el nombre del parámetro que contiene el mismo Array que se ha subido en el ejemplo. Si la respuesta del servicio es directamente un Array, puede dejarse vacío.

Atributos de los objetos de la lista : Para cada elemento del JSON del ejemplo anterior, habrá un campo que debes enlazar con un campo del formulario seleccionado. Ten en cuenta que cada atributo solo puede enlazarse con un campo, y no puedes enlazar más de un atributo al mismo campo de formulario.

Compártelo
Share on linkedin
Share on facebook
Share on twitter
Share on google
Share on whatsapp

Deja un comentario

ARTÍCULOS RELACIONADOS