Traer datos de una API externa

Un reporte puede traer sus filas de una API externa en lugar de los datos de Prolibu. Sirve, por ejemplo, para poner en un mismo tablero datos de otra plataforma. Necesitas la dirección de la API y saber en qué parte de la respuesta vienen los registros.

Activar los datos externos

1. Abre Herramientas → Analítica → Reportes y pulsa el botón redondo + de la esquina inferior derecha.
2. En Nombre, escribe cómo se llamará el reporte.
3. Activa Usar datos externos. El campo Entidad desaparece y aparece Configuración externa.

Configurar la petición

1. En URL, escribe la dirección de la API. Admite variables entre llaves dobles, como {{dateRange.start}}.
2. En Método, deja GET o elige otro.
3. En Ruta de los datos, escribe dónde está la lista de registros dentro de la respuesta, por ejemplo slideshow.slides. Vacía, Prolibu intenta detectarla.
4. Revisa Formato de variables de fecha. De fábrica es YYYY-MM-DD.

Si ya tienes la petición como comando curl, pulsa Importar curl, pega el comando en Comando curl y pulsa Importar.

Añadir cabeceras

Si la API pide una clave o un token:

1. Despliega Cabeceras.
2. Escribe el Nombre y el Valor de la cabecera.
3. Pulsa Añadir para otra cabecera. La papelera quita una.

Más abajo están Parámetros de consulta y Paginación (de fábrica, none · 20).

Detectar los campos

Un reporte con datos externos necesita al menos un campo definido. Si pulsas Crear sin campos, no se guarda.

1. Baja hasta Definiciones de campos y pulsa Detectar campos.
2. Prolibu hace la petición y muestra Petición enviada con el método y la URL, y cuántas secciones encontró en la respuesta.

3. Pulsa Aplicar. Aparece 3 campos aplicados (o los que tenga tu respuesta).
4. Si la API trae fechas, elige en Campo de fecha cuál usar. Así el reporte filtra sus filas cuando cambias el rango de fechas del tablero.

Si cambias la URL o la ruta, pulsa Volver a consultar para detectar los campos otra vez.

Crear el reporte

1. Pulsa Crear.
2. Se abre la ficha del reporte. El Visualizador de datos muestra la etiqueta Datos externos y una fila por registro de la API, con los campos detectados como columnas.

El panel Editar Reporte resume la configuración como Configuración externa con el número de ítems. Si cambias algo, pulsa Guardar y actualizar para volver a pedir los datos a la API.