La integración por Archivos permite a YOM acceder a los archivos de datos y procesarlos regularmente para mantener la información actualizada en nuestros sistemas. Se ajusta a empresas que tienen la capacidad de generar reportes periódicos en forma de archivos, pero no disponen de los recursos técnicos para exponer datos a través de endpoints o manejar la carga en tiempo real.
La integración por Archivos implica que el cliente deposita archivos de datos en un servidor SFTP seguro. YOM accederá a este servidor periódicamente para descargar los archivos y actualizar sus sistemas con la información proporcionada. Este método es adecuado para datos que no cambian con mucha frecuencia y que pueden ser actualizados en intervalos regulares.
Una integración por Archivos puede ser de dos tipos, según los productos de YOM que se quieran habilitar:
| Tipo | Descripción | Habilita |
|---|---|---|
| Inteligencia | Recopila información del cliente para obtener insights y análisis. | • Dashboards |
| Operacional | Habilita los productos de ventas de YOM. Requiere integrar todos los conceptos o entidades que YOM requiere para realizar ventas a través de sus productos. | • B2B |
| • App Vendedores | ||
| • Call Center | ||
| • LLM Commerce |
A continuación se listan los requisitos técnicos necesarios para implementar una integración por Archivos con YOM. Aplican a ambos tipos de integración, salvo la estructura de carpetas, que se detalla para cada tipo.
El servidor donde estén los archivos puede ser del cliente o en un servidor de YOM.
YOM hosteará un servidor SFTP para los ambientes de staging y production. Las credenciales a manejar son:
sftp-integrations.youorder.mePara garantizar la seguridad, el acceso al servidor SFTP se realiza mediante autenticación SSH con clave privada. YOM proporcionará al cliente un archivo que contiene la clave privada necesaria para autenticarse.
<aside> ⚠️
La clave privada debe mantenerse segura y nunca compartirse con terceros.
</aside>
*\Coordinar con equipo TI.
Los archivos deben estar en formato CSV, con punto y coma ; como separador por defecto y encoding UTF-8.
Separador → ;
Encoding → UTF-8
La estructura de sus nombres debe ser:
<fecha>_<hora>_<entidad>.csv
Formato Fecha → YYYYMMDD
Formato Hora → HHMMSS
Ejemplo para un archivo con lista de Products cargado el día 01 de febrero de 2024 a las 18 hrs:
20240201_180000_product.csv
La estructura de carpetas depende del tipo de integración.
Se debe implementar una estructura de carpetas como la siguiente:
/<nombre_cliente>
/production
/load
/product
/all
20240201_180000_product.csv
20240201_073000_product.csv
20240131_180000_product.csv
20240131_073000_product.csv
/created
...
/updated
...
/commerce
/all
20240201_180000_commerce.csv
20240131_180000_commerce.csv
20240130_180000_commerce.csv
/created
...
/updated
...
/override
...
...
/development
...
Explicación de la estructura de carpetas
/<nombre_cliente> → Esta carpeta principal representa al cliente específico que se integra con YOM.
<aside> 🚧
</aside>
Los archivos se organizan por cliente, entidad y fecha de carga:
/integrations
/<customer_id>
/commerce
/20251228
20251228_180000_commerce.csv
/product
/20251228
20251228_180000_product.csv
/seller
/20251228
20251228_180000_seller.csv
/transaction
/20251228
20251228_180000_transaction.csv
...
Explicación de la estructura de carpetas
/integrations → Carpeta raíz de la integración Inteligencia.
Las entidades se definen originalmente como objetos con campos anidados, los cuales representan objetos o listas. Están pensadas para ser transmitidas mediante estructuras JSON en la integración por Integración por API.
Para convertir estructuras JSON anidadas en un formato CSV, es necesario "aplanar" los objetos, es decir, convertir las propiedades anidadas en una estructura de clave-valor plana.
Para aplanar un objeto JSON a un formato CSV, se sigue la siguiente lógica: