Configuración de fuente Global Json

Esta documentación tiene como objetivo obtener información de una API através de 4YouSee Manager. De este modo usted podrá hacer llamados a dicha a API y recibir la información dentro de su cuenta de 4YouSee Manager. 

Para proceder con la configuración se necesitan seguir los siguientes pasos:

1. Crear un Perfil de Conexión. Con nombre GlobalJson con clase de conexión llamado GlobalJson y las strings method, url, filter y arguments.
   1. Información Importante del Perfil de Conexión.
2. Crear un canal: Este puede tener el nombre de "GlobalJson".
3. Crear y configurar una Fuente de Datos.

1.1 Información Importante del Perfil de Conexión.

El perfil de conexión del tipo GlobalJson usa el protocolo HTTP para realizar las consultas. Una solicitud de protocolo HTTP tiene 3 piezas de información:

1. Un Request Line
2. Un Request Header
3. Un Request Body

El Request Line es el único parámetro obligatorio, se divide en dos partes: el método HTTP (que puede ser solo GET o POST) y la ubicación del recurso (URL).

Los demás campos son opcionales y dependen de la API json a la que se accederá, los datos suelen explicarse en la documentación, dónde se pasan las contraseñas, tipo de autenticación, tokens, etc.

1. El Header, el encabezado de la solicitud, contiene información opcional adicional para los servidores a los que enviamos información sobre esa solicitud.
2. El Body, normalmente no se usa en solicitudes GET. Es más útil en POST. Recibe un json y lo convierte en query-builder.
3. El Filter,cuando se completa, debe recibir una cadena que informe los niveles de json que se obtendrán, separados por el carácter '&'. Por ejemplo: fecha y unidades.
4. El Arguments, cuando se llena, busca el siguiente nivel del filtro donde se informan los valores que está buscando. Debe recibir una cadena informando el campo y el valor a buscar, separados por los signos "==", se pueden pasar otros argumentos y también debe estar entre el carácter "&". Por ejemplo: CodigoUnidadAsistencia==104&CodigoUnidadOperacional==2. Si es necesario, incluya dos o más argumentos con el mismo nombre, pero los valores deben estar separados por "||" . Ejemplo: código == 659843 || código == 875346.

Con el perfil creado, el siguiente paso es crear un canal para poder enlazar a una fuente de datos.

3. Agregar Fuente de datos

Una vez creado el canal, acceda al menú Fuente de datos (1), haga clic en Fuentes de Datos (2), luego en .

3.1 Configuración de la fuente de datos

Después de haber hecho click en , complete los campos de la siguiente manera:

1. Perfil de conexión: seleccione el perfil de conexión de tipo "GlobalJson" que creó;
2. Canal: seleccione el canal que creó en el paso 1;
3. Nombre: introduzca un nombre para la fuente, por ejemplo, "Api Json" o "Global Json";
4. url: API url
5. method: método para acceder a la api
6. headers: opcional
7. body: opcional
8. filter: opcional 

Una vez que haya agregado los datos, verifique si el manager puede capturar las solicitudes haciendo clic en "Comprobar consulta". Si regresa con los datos correctos, haga clic en Agregar y se guardará su fuente de datos. Si vuelve reportando algún tipo de error, verifique si la información coincide con la documentación.