---
title: "Navegando Swagger UI"
description: "Aprende a usar la documentación interactiva (OpenAPI) para explorar y probar la API de API Gateway"
type: "academy"
category: "lesson"
tags: []
authors: [Anonymous]
date: "2026-08-27"
last_update: "2026-08-21"
time_minutes: 4
draft: false
unlisted: false
url: "https://www.stage.apigateway.cl/academy/primeros-pasos/punto-de-partida/navegando-swagger"
---

# Navegando Swagger UI

La documentación interactiva (a menudo **Swagger UI**) te permite **ver** las operaciones, **leer** parámetros y respuestas esperadas, y **probar** llamadas reales desde el navegador sin programar al inicio. Si nunca usaste una API, piensa en un **menú de servicios**: cada operación es una **receta** con método (GET, POST…), ruta, datos de entrada y respuesta.


## Accediendo a la documentación interactiva


Abre la documentación en [apigateway.cl/docs/api](https://www.apigateway.cl/docs/api), o desde [www.apigateway.cl](https://www.apigateway.cl) en el menú **Documentación → API (V2)**.


Al ingresar verás el **título** del servicio y su descripción, la **versión** del esquema OpenAPI, el **servidor / URL base** donde se ejecutan las peticiones (habitualmente `https://app.apigateway.cl/api/v2/`) y el listado de **operaciones** agrupadas por categorías.


## Estructura de la interfaz

Los endpoints están organizados por categorías:

```
📁 SII - Consultas
  └── GET /api/v2/sii/contribuyentes/{rut}
  └── POST /api/v2/sii/situacion-tributaria
  └── POST /api/v2/sii/actividades

📁 LibreDTE - Emisión
  └── POST /api/v2/libredte/dte/documentos/generar
  └── POST /api/v2/libredte/dte/envios/enviar

📁 Utilidades
  └── GET /api/v2/utilidades/validar-rut
  └── POST /api/v2/utilidades/convertir-moneda
```

### Colores y métodos HTTP

Cada método HTTP suele tener un color distintivo en la interfaz:

| Método | Color (típico) | Uso sencillo |
|--------|----------------|--------------|
| **GET** | 🟦 Azul | Pedir información (muchas veces sin cuerpo JSON) |
| **POST** | 🟩 Verde | Enviar datos en el cuerpo (por ejemplo credenciales de la plataforma) |
| **PUT** | 🟨 Amarillo | Actualizar un recurso completo |
| **DELETE** | 🟥 Rojo | Eliminar o anular según el endpoint |

## Funcionalidad "Try it out"

> [!WARNING] Importante
>
> Las peticiones que ejecutes desde **Try it out** son **reales**: van a **API Gateway** y, si el endpoint lo requiere, usará la plataforma relacionada con la consulta con los datos que ingreses. Usa credenciales y RUTs con cuidado.

1. Haz clic sobre un endpoint para expandirlo
2. Pulsa **Try it out** (habitualmente arriba a la derecha del bloque)
3. Los campos pasan a ser editables

### Completar los datos

Para **GET** con parámetros en la ruta o query, se completan campos como `rut: 76192083-9` o `formato: json`. Para **POST**, se envía un cuerpo JSON, por ejemplo:


```
Path parameter:
rut: 76192083-9

Query parameters (si existen):
formato: json
```

```json
{
  "auth": {
    "pass": {
      "rut": "11111111-1",
      "clave": "miclave"
    }
  }
}
```

Recuerda: además del body, la API exige el token de conexión (ver siguiente apartado).

### Configurar autorización

Las operaciones están protegidas con un **token por conexión**:

1. Busca **Authorize** (o el esquema de seguridad indicado) 🔐
2. Introduce tu token según pida el formulario (a veces solo la clave, a veces el texto completo `Token tu_clave`)
3. Confirma con **Authorize**
4. Un candado cerrado 🔒 suele indicar que las siguientes pruebas enviarán el token automáticamente

La cabecera HTTP correcta es:

```http
Authorization: Token <tu_token>
```

El token lo generas en [Gestionar conexión](https://app.apigateway.cl/connections/manage#token)
- Abre **Gestionar conexión**
- Ve a la pestaña **Token API**
- Genera el token

> [!NOTE] Nota
>
> Si todo está bien, el candado aparece cerrado, puedes ver parte del token oculto y suele haber opción **Logout** en el modal de autorización.

## Ejecutar y ver resultados

Consideraciones:

1. Revisa parámetros y JSON
2. Clic en **Execute**
3. La herramienta envía la petición al servidor y muestra el resultado en la sección de **Response**.

La pantalla suele mostrar, en este orden:

1. **Curl command** — comando listo para copiar en terminal
2. **Request URL** — URL completa llamada
3. **Response status** — código HTTP (200 éxito, 401 error de autenticación, etc.)
4. **Response headers** — metadatos (límites, créditos, tiempos; ver guía [Tu primera petición](./primera-peticion))
5. **Response body** — JSON (u otro formato) con los datos o el mensaje de error

#### Ejemplo de bloque tipo cURL (ilustrativo)

```bash
curl -X 'GET' \
  'https://app.apigateway.cl/api/v2/sii/contribuyentes/situacion_tributaria/tercero/76192083-9' \
  -H 'accept: application/json' \
  -H 'Authorization: Token tu_token_aqui'
```

#### Ejemplo de cuerpo de respuesta exitosa (ilustrativo)

```json
{
  "data": {
      "rut": 76192083,
      "dv": "9",
      "razon_social": "EMPRESA DEMO",
      "inicio_actividades": true
  }
}
```


---
Last updated on 21/08/2026