Las exportaciones crean archivos descargables a partir de los datos de Syntage. Úsalas cuando tu integración necesite un archivo que pueda almacenarse, compartirse, importarse a otro sistema o entregarse a un equipo de operaciones.
Crear una exportación inicia un procesamiento asíncrono y devuelve un recurso Export. La exportación mantiene un registro de los datos de origen solicitados, el formato de salida, el estado del procesamiento y el archivo generado.
Cómo funcionan las exportaciones
- Crea una exportación con la URI de colección y el formato de salida que necesites.
- Almacena el ID de exportación devuelto.
- Consulta la exportación hasta que su
status sea finished o failed.
- Descarga el archivo generado desde el recurso File referenciado por la exportación.
Las exportaciones son útiles para flujos de trabajo como reportes financieros, entregas de facturas, investigaciones de soporte al cliente, revisión de back-office y entrega programada de datos.
Para detalles de endpoints, consulta la Referencia de API de Exportaciones.
| Estado | Significado |
|---|
pending | La exportación fue aceptada y está esperando ejecutarse. |
running | Syntage está construyendo el archivo de exportación. |
finished | El archivo de exportación está listo para descargarse. |
failed | La exportación no pudo completarse. Crea una nueva exportación después de corregir la solicitud. |
La respuesta de exportación referencia un recurso File cuando el archivo generado está listo. Usa los metadatos del archivo para inspeccionar el nombre, el tipo de medio y el tamaño antes de descargarlo.
