Crear y getionar recolecciones de datos

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.

Esta funcionalidad está diseñada específicamente para usuarios que no cuentan con perfiles técnicos o conocimientos de programación, permitiéndoles ejecutar integraciones complejas de forma sencilla sin necesidad de conectar directamente con las APIs.

Un caso común es la recepción de un archivo CSV para realizar la creación masiva de cuentas en un sistema externo.

Puedes gestionar estas funciones desde Workspace > Recolecciones de datos.

Configuración de una recolección de datos

Para crear una recolección de datos haga clic en el botón Nueva Recolección de datos.

Al crear una recolección deberá completar su título y descripción, que serán mostrados a los usuarios del Portal de APIs.

En el siguiente paso, debe aplicar las principales configuraciones de la recolección de datos:

En este paso, deberá definir los parámetros principales que regirán el comportamiento de las recolecciones de datos:

Frecuencia de creación de instancias: Define cada cuánto tiempo se habilitará una nueva instancia de recolección (la entidad que permite al usuario realizar un envío). Puede configurar un horario simple o utilizar una expresión Cron para una programación más específica.
Nota: Cada instancia representa una oportunidad única de envío para el usuario.
Vigencia de la instancia (Límite de envío en horas): Es el tiempo máximo, expresado en horas, que el usuario tiene para completar y enviar la recolección una vez que la instancia se ha generado. Si el usuario no realiza el envío dentro de este plazo, la instancia expira y ya no podrá ser utilizada.
Estado (Activar/Pausar): Este interruptor habilita o suspende la creación periódica de nuevas instancias. Es una opción útil para realizar mantenimientos o detener el flujo de ingresos de datos temporalmente sin eliminar la configuración.
Notificación de nueva instancia: Al activar esta opción, el sistema enviará automáticamente un correo electrónico a los usuarios finales cada vez que una nueva instancia de recolección esté disponible para ellos.

Por último, debe especificar el método de la API que procesará la información recibida. La ejecución de la Recolección de Datos se rige por las siguientes condiciones técnicas:

Interfaz del Método: El método seleccionado debe estar preparado para recibir un parámetro de tipo file. Es obligatorio que la petición soporte el Content-Type: multipart/form-data para procesar correctamente el archivo enviado por el usuario.
Parámetros Adicionales y Variables de Contexto: Además del archivo, el método puede incluir otros parámetros que el usuario deberá completar al momento del envío. El sistema permite el uso de variables de contexto vinculadas a estos parámetros, lo que facilita la inyección de datos dinámicos durante la ejecución.
Lógica de Procesamiento: Dependiendo de la arquitectura de su solución, el método puede ejecutar una Vista o un Pipeline de datos.
Seguridad y Concurrencia:
- Autenticación: El método puede estar protegido mediante protocolos estándar como OAuth 2.0 o API Keys.
- Sincronía: Aunque se admiten procesos sincrónicos, se recomienda el uso de métodos asincrónicos, dado que el procesamiento de archivos masivos suele requerir tiempos de ejecución prolongados.

Plantilla Jinja: Para determinar si la ejecución del método fue exitosa, el sistema utiliza una Plantilla Jinja. Esta lógica de evaluación debe procesar la respuesta de la API y retornar estrictamente un valor booleano.

True: La respuesta se registra como exitosa.
False: La respuesta se marca como fallida.

Compartir recolección de datos

Para otorgar acceso a una recolección:

Diríjase al listado de recolecciones dentro del Workspace.
Identifique la recolección deseada y haga clic en el botón Compartir, ubicado justo debajo del título.
Desde allí, podrá definir qué usuarios, grupos o roles tendrán permisos sobre esta funcionalidad.

Para que el uso de la recolección funcione, debe el usuario que utiliza la recolección debe tener acceso al método de la API que ejecuta la recolección.