Saltar al contenido principal
Los archivos son artefactos binarios o de texto producidos por los recursos de Syntage, como PDFs, archivos XML, exportaciones CSV y reportes generados. La mayoría de los registros de archivos se devuelven primero desde otro recurso. Por ejemplo, una factura, declaración fiscal, exportación, verificación de antecedentes o reporte de Verificación de Sociedad puede incluir uno o más archivos. Usa el endpoint de archivos cuando necesites los metadatos del archivo, y usa el endpoint de descarga cuando necesites el contenido real del archivo. El tipo de contenido de la respuesta de descarga depende del archivo almacenado. Los formatos comunes incluyen PDF, XML, CSV, XLSX, JSON y texto plano.
Usa los metadatos del archivo para inspeccionar el tipo, nombre, tamaño y recurso relacionado antes de descargar el contenido.

​
Cómo se usan los archivos

  1. Obtén un recurso que referencie un archivo, como una factura, exportación, declaración fiscal, reporte o verificación de antecedentes.
  2. Almacena el ID o el IRI del archivo si tu integración necesita recuperar el archivo más adelante.
  3. Recupera el archivo cuando necesites metadatos como nombre, tipo de medio, tamaño o recurso relacionado.
  4. Usa el endpoint de descarga cuando necesites el contenido del archivo.

​
URLs de descarga

Para descargar un archivo, llama a GET /files/{id}/download con el ID del recurso de archivo. La respuesta de descarga devuelve una redirección: el header Location contiene la URL real donde se sirve el contenido. Tu cliente HTTP debe seguir la redirección para recibir los bytes. La URL de la redirección es de corta duración, así que solicítala nuevamente cada vez que necesites descargar. La mayoría de los clientes HTTP siguen redirecciones por defecto. Si el tuyo no lo hace, habilita el seguimiento de redirecciones (por ejemplo, curl -L) antes de leer el cuerpo de la respuesta. También puedes pasar ?redirect=false para recibir una respuesta JSON con el url generado. Para detalles de endpoints, consulta la Referencia de API de Archivos.