Resumen

Recolecciones de Datos es una funcionalidad diseñada para gestionar la recepción de archivos directamente desde el Portal de APIs. A través de esta herramienta, el usuario del portal puede cargar archivos, completar parámetros y ejecutar procesos de integración sin perfil técnico ni conocimientos de programación. Un caso común es la recepción de un archivo CSV para la creación masiva de cuentas en un sistema externo. En este video ve el recorrido completo: crear la recolección en el workspace, compartirla y enviar un archivo desde el portal.

Antes de comenzar

• El método que procesará los archivos debe tener un parámetro de tipo archivo (file) y aceptar solicitudes multipart/form-data. Solo esos métodos aparecen en el asistente.
• El usuario que envía archivos debe tener acceso al método que ejecuta la recolección.

Configurar una recolección de datos

Desde Workspace › Recolecciones de datos, haga clic en Nueva recolección de datos y complete los tres pasos del asistente.

Descripción

Complete el título y la descripción, que se muestran a los usuarios del Portal de APIs.

Programación

• Frecuencia de creación de instancias: define cada cuánto tiempo se habilita una nueva instancia de recolección, la entidad que permite al usuario realizar un envío. Puede configurar un horario simple o una expresión cron. Cada instancia representa una oportunidad única de envío para el usuario.
• Límite de tiempo de envío (horas): tiempo máximo que el usuario tiene para enviar la recolección una vez generada la instancia. Si no envía dentro de ese plazo, la instancia expira.
• Activo: habilita o suspende la creación periódica de instancias, útil para mantenimientos o para detener el flujo sin eliminar la configuración.
• Notificación de nueva instancia: envía un correo a los usuarios cada vez que una nueva instancia está disponible.

Método

Especifique el método de la API que procesará la información recibida. Además del archivo, el método puede incluir otros parámetros que el usuario completa al enviar, con la posibilidad de vincularlos a variables de contexto. El método puede ejecutar una vista o un pipeline, estar protegido con API Keys u OAuth 2.0, y conviene que sea asincrónico cuando el procesamiento de archivos es prolongado. La plantilla Jinja de evaluación procesa la respuesta de la API y debe devolver True para marcar el envío como exitoso o False para marcarlo como fallido.

Compartir la recolección

En el listado de recolecciones del workspace, seleccione la recolección y abra la acción Compartir. Defina qué usuarios, grupos o roles tendrán acceso y guarde. A partir de la siguiente instancia programada, cada usuario con acceso recibe su propia instancia.

Utilizar la recolección desde el portal

En el inicio del portal, la sección Recolecciones de datos lista las recolecciones pendientes y todas las que tiene asignadas. Al abrir una, la pantalla muestra:

• Panel de resumen de instancias: cantidades Por hacer, En progreso, Fallida, Expirada y Éxito.
• Historial de envíos: cada instancia generada según la frecuencia programada, con fecha, hora y estado. Al seleccionar una instancia Por hacer se habilita el formulario de envío.
• Formulario de envío: la fecha límite y el tiempo restante, los parámetros adicionales del método, el área para arrastrar el archivo o buscarlo en el equipo, y el botón Enviar, que ejecuta el método de la API.

Al seleccionar una instancia Éxito o Fallida del historial se muestran los detalles de la ejecución.

Resultado esperado

Después de enviar, la instancia pasa a En progreso mientras el método procesa el archivo y termina en Éxito o Fallida según la plantilla de evaluación. En el video, la recolección queda creada y compartida, el desarrollador la ve pendiente en el portal y envía su archivo desde la instancia Por hacer.

Errores frecuentes

• El método no aparece en el asistente: la vista o el pipeline que expone no tiene un parámetro de tipo archivo.
• El usuario no ve la recolección en el portal: no fue compartida con su usuario, grupo o rol, o todavía no se generó una instancia desde que se compartió.
• La instancia figura como Expirada: venció el límite de horas de envío. Habrá una nueva instancia en la próxima ejecución programada.
• El envío termina en Fallida: el método respondió con error, el usuario no tiene acceso al método o la plantilla de evaluación devolvió False. Revise el detalle de la ejecución.

Artículos relacionados

• Recolecciones de datos en el portal
• Crear métodos de APIs
• Gestionar grupos de usuarios
• Cómo crear y usar distribuciones de datos