Explorando Formatos de Respuesta

API Gateway no solo devuelve JSON. Dependiendo de tus necesidades, puedes obtener los datos en diferentes formatos que faciliten su procesamiento o presentación. Esto es especialmente útil cuando necesitas mostrar información directamente a usuarios o integrar con sistemas que esperan formatos específicos.

Formatos Disponibles

El formato disponible depende del endpoint que estés consultando.

Formatos Principales

Modificando el Formato en Swagger

Paso 1: Localizar el Parámetro

1. Busca un endpoint que soporte múltiples formatos
2. Observa la sección “Parameters”
3. Encuentra el parámetro formato (query parameter)

Paso 2: Cambiar el Formato

En Swagger UI:

1. Click en “Try it out”
2. En la sección de parámetros, busca formato
3. Selecciona o escribe el formato deseado
4. Ejecuta la petición

Ejemplo Visual en URL

# JSON (default)
/api/v1/sii/ejemplo/11111111-1/datos

# HTML
/api/v1/sii/ejemplo/11111111-1/datos?formato=html

# CSV
/api/v1/sii/ejemplo/11111111-1/datos?formato=csv

Trabajando con Cada Formato

JSON - Procesamiento Programático

Cuándo usar:

• Integración con aplicaciones
• Procesamiento automatizado
• APIs REST

Ejemplo de respuesta:

{
  "rut": "11111111-1",
  "razon_social": "EMPRESA DEMO",
  "actividades": [
    {
      "codigo": 620100,
      "descripcion": "ACTIVIDADES DE PROGRAMACION INFORMATICA"
    }
  ]
}

HTML - Presentación Directa

Cuándo usar:

• Mostrar información al usuario final
• Evitar diseñar interfaces propias
• Mantener formato oficial del SII

Características:

• Incluye estilos del SII
• Listo para mostrar en iframe o ventana
• No requiere procesamiento

CSV - Análisis de Datos

Cuándo usar:

• Exportar a Excel
• Análisis masivo
• Reportes

Configuración adicional:

?formato=csv&csv_delimiter=;

Delimitadores disponibles:

• , (coma) - Por defecto
• ; (punto y coma) - Para Excel en español

Ejemplo de respuesta:

rut;razon_social;actividad_codigo;actividad_descripcion
11111111-1;EMPRESA DEMO;620100;ACTIVIDADES DE PROGRAMACION INFORMATICA

XML - Formato Original SII

Cuándo usar:

• Sistemas que requieren XML
• Mantener estructura original del SII
• Validaciones con esquemas XSD

Casos de Uso Prácticos

Caso 1: Dashboard Ejecutivo

Necesidad: Mostrar datos del SII en pantalla Solución: Formato HTML en iframe

<iframe src="https://api.../datos?formato=html" />

Caso 2: Reporte Mensual

Necesidad: Analizar datos en Excel Solución: Formato CSV con delimitador ;

?formato=csv&csv_delimiter=;

Caso 3: Integración con ERP

Necesidad: Procesar datos automáticamente Solución: Formato JSON (default)

Caso 4: Sistema Legacy

Necesidad: Sistema antiguo espera XML Solución: Formato XML

?formato=xml

Consideraciones Importantes

Disponibilidad de Formatos

No todos los endpoints soportan todos los formatos. En Swagger verás:

• Si el parámetro formato está disponible
• Qué valores acepta