--- title: "Consultas usando Postman" description: "" type: "academy" category: "module" tags: [] authors: [Anonymous] date: "2026-08-27" last_update: "2026-08-21" time_minutes: 14 draft: false unlisted: false url: "https://www.stage.apigateway.cl/academy/capacitacion-inicial/consultas-usando-postman" --- # Consultas usando Postman --- ## API Gateway orientado a Postman API Gateway orientado a Postman # API Gateway orientado a Postman [API Gateway](https://www.apigateway.cl/) provee una forma de interactuar con el SII para extracción de datos, es una pasarela entre un software propio y el SII. API Gateway cuenta con Servicios Web de tipo REST para **interactuar con diferentes características del SII**. Estos Servicios Web tienen como objetivo final, permitir a los usuarios **conectar su propio software con la plataforma web de SII** para realizar tareas de extracción de datos y facturación. La documentación completa se encuentra en [API Gateway](https://www.apigateway.cl/docs/api). ## Autenticación mediante OAuth2 La API soporta sólo el método de autenticación mediante OAuth2. La forma más simple de empezar a probar la API es generar un Access Token a través de la **plataforma web de la API** y hacer las solicitudes enviando el token en la cabecera: ` Authorization: Bearer ACCESS-TOKEN ` Primero debes entrar con el usuario y contraseña en la plataforma web de la API. ![Imagen de web](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-1.jpg) Dirigirse a “Autenticación de API”. ![Autenticación de API](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-2.jpg) Luego a “Crear nuevo token”. ![Crear nuevo token](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-3.jpg) > [!INFO] IMPORTANTE > >Una vez añadido el nombre del token se debe copiar y ya que es la única vez podrás ver el Token. ![copiar](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-4.jpg) ### ¿Por qué recomendamos Postman para realizar pruebas? Postman nos permite realizar peticiones de una manera simple para testear APIs de tipo REST propias o de terceros, además que es la forma más rápida y efectiva de no tener que programar para poder revisar el código y realizar pruebas. ![Postman](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/postman-logo.jpg) --- ## ¿Cómo crear una cuenta en Postman? ¿Cómo crear una cuenta en Postman? # ¿Cómo crear una cuenta en Postman? Hay que dirigirse al siguiente [enlace de Postman](https://identity.getpostman.com/login) y enlazar tu cuenta en la plataforma que se estime conveniente. ![Run in](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-5.jpg){.w-25 .d-block .mx-auto .img-fluid .mb-2 .rounded-3 .shadow} ## ¿Cómo crear una colección de API GATEWAY en Postman? Para poder crear la colección de Postman debes importarla directamente desde el [archivo OpenAPI de API Gateway](https://www.apigateway.cl/docs/api/_attachments/apigateway-api-schema.yaml). ### Paso 1: Importar el schema OpenAPI Puedes importar el schema de dos formas: a. **Desde URL**: Copia la URL del schema (`https://www.apigateway.cl/docs/api/_attachments/apigateway-api-schema.yaml`) y en Postman selecciona **"Import" > "Link"** y pega la URL. Postman detectará automáticamente el archivo OpenAPI. b. **Desde archivo**: Descarga el archivo YAML y luego en Postman selecciona **"Import" > "File"** y elige el archivo descargado. A continuación se muestra un ejemplo de importación desde URL. Postman detectará automáticamente el schema una vez que pegues la URL: ![import url](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/import-url.png){style="width: 70%; display: block; margin: 0 auto;"} ### Paso 2: Configurar la importación Antes de finalizar la importación, haz clic en **"View Import Settings"**. ![folder organization tags](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/folder-organization-tags.png){style="width: 70%; display: block; margin: 0 auto;"} Cambia la opción **"Folder organization"** de "Paths" a **"tags"**. Esto organizará mejor los endpoints en la colección agrupándolos por categorías. Una vez realizado el cambio, la pantalla mostrará la opción seleccionada. Finalmente, haz clic en el botón **"Import"** para completar la importación. ![select tag import](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/select-tag-import.png){style="width: 70%; display: block; margin: 0 auto;"} > [!TIP] Importante > >Si se utiliza POSTMAN WEB comparte la IP con otros usuarios de Postman web. Por lo que tu cuenta en Plan Inicia o Estándar se bloqueará. Si tienes alguno de esos planes, y quieres probar la API, usa la aplicación de escritorio de Postman. Así usarás tu propia IP en las consultas. > >Si no quieres que esto suceda es recomendable usar la versión escritorio de Postman e importar la colección. > [!NOTE] Nota > >La ejecución de Postman te derivará a la última versión dependiendo tu sistema operativo. ## Configuración de Environments Una vez importada la colección, debes configurar las variables de entorno necesarias para poder consumir los servicios de API Gateway. ### Crear o seleccionar un Environment En Postman, dirígete a la sección **"Environments"** y crea un nuevo entorno o selecciona uno existente (por ejemplo, "apigateway"). ![Environments - apigateway.cl](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-8.jpg) ### Configurar la variable bearerToken Cuando importas la colección desde el schema OpenAPI, Postman crea automáticamente una variable llamada **bearerToken** para la autenticación Bearer. Debes configurar esta variable en tu Environment con el token de autenticación de API Gateway: ![Environments](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-9.png) **Variable a configurar:** - **bearerToken**: Tu token de autenticación de API Gateway (sin incluir el prefijo "Bearer ") > [!NOTE] Nota > > Esta variable es generada automáticamente por Postman al importar schemas que usan autenticación Bearer. Solo debes ingresar el valor de tu token en el campo "CURRENT VALUE" de esta variable. ### Seleccionar el Environment activo Una vez configurado el token en tu Environment, asegúrate de seleccionar el entorno que creaste en el selector de entornos ubicado en la esquina superior derecha de Postman. Esto es necesario para que las variables configuradas se apliquen a tus peticiones. Con esto, ya estarás listo para comenzar a usar la API de API Gateway desde Postman. --- ## Consultas al SII Consultas al SII: # Consultas al SII: ## Contribuyentes Para encontrar la carpeta que tiene el siguiente servicio debes seguir la siguiente ruta: **API GATEWAY →Consultas al SII → Contribuyentes → `GET` Situación tributaria de contribuyentes.** ![my workspace](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-18.jpg) * Situación tributaria de contribuyentes: Se deben configurar los parámetros que indica el campo, en este caso es el RUT el cual deseas consultar, se selecciona “Send”. Se mostrará en BODY los datos solicitados. ![send](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-19.jpg) ## Registro de compras y ventas Para encontrar la carpeta que tiene el siguiente servicio debes seguir la siguiente ruta: **API de LibreDTE →Consultas al SII →Registro de compras y ventas → Registro de compras → `POST` Resumen de compras.** ![API SII](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-20.jpg) Para consumir el servicio registro de compra y venta es necesario tener configuradas en la colección las variables de **EMPRESA_RUT o USUARIO_RUT** > [!NOTE] Nota > > Este servicio lo puede consumir toda persona autorizada para pedir el registro, es decir, puede ser tanto con RUT de empresa como también de una persona natural que esté autorizada. ## Registro de compras * Detalle de compras: Se deben definir los parámetros que se indican: * **Receptor:** RUT del receptor de los documentos. * **Período:** Período del registro. * **DTE:** Tipo de documento. * **Estado:** REGISTRO, PENDIENTE, NO_INCLUIR, RECLAMADO. Una vez definidos al seleccionar **“Send”**, en **“Body”** mostrará los detalles solicitados. ![send](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-21.jpg) --- ## Documentos tributarios electrónicos Documentos tributarios electrónicos # Documentos tributarios electrónicos Para encontrar la carpeta que tiene el siguiente servicio debes seguir la siguiente ruta: **API de LibreDTE →Consultas al SII →Documentos tributarios electrónicos →Contribuyentes → `GET` Estado Autorización de un Contribuyente** ![collections](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-22.jpg) Para consumir el servicio es necesario tener configuradas en la colección las variables de **USUARIO_FIRMA_PUBLIC_KEY / USUARIO_FIRMA_PRIVATE_KEY** > [!NOTE] Nota > >Este paso está explicado en ¿Cuáles son los entornos y cómo configurar cada uno?. ![variables necesarias](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-23.jpg) --- ## Contribuyentes Contribuyentes # Contribuyentes * **Estado Autorización de un Contribuyente:** Se deben configurar los parámetros que indica el campo, en este caso es el RUT a consultar: * Se añade y se debe seleccionar **“Send”**. Ahora se mostrará en el BODY los datos solicitados, permitiendo descargar la base de datos de contribuyentes autorizados por el SII a operar con documentos tributarios electrónicos. ![send](https://www.apigateway.cl/img/content/academy/capacitacion-inicial/apigateway-orientado-a-postman/apigateway-orientado-a-postman-24.jpg) ## ¿Qué debo tener en consideración si contrato el servicio? ### Límite de consultas La API Gateway tiene un límite de consultas por rango de tiempo, para así evitar sobrecargas que afectan nuestra capacidad de mantener un rendimiento óptimo de nuestra API. La cantidad de consultas que se pueden realizar por período de tiempo dependen del tipo de cuenta que se esté usando para acceder a la API. Cuando se alcanza el límite de consultas asignadas, la API entregará una respuesta HTTP de código **429**. Al recibir este código, el usuario debe obligatoriamente dejar de hacer consultas a la API. ### Bloqueo Automático Si la cuenta excede las **10 consultas sobre la cuota** disponible, será bloqueada automáticamente por **3 días completos**. Durante este período se le impedirá al usuario realizar consultas, obteniendo una respuesta HTTP de código **423**. No es posible quitar el bloqueo solicitando ayuda técnica o soporte. Adicionalmente, está prohibido que 2 o más usuarios realicen consultas desde la misma dirección IP. Por ejemplo, usar **Postman en su versión web** compartirá la IP con otros usuarios de Postman web, lo que bloqueará tu cuenta. Debes usar la aplicación de escritorio de Postman instalada en tu computador. **Persistencia de datos** La empresa o persona que adquiera el servicio debe guardar los documentos, ya que nuestra API solo realiza consultas y extrae datos. <twig:block-cta class="my-4 rounded p-4" title="¿Necesita ayuda adicional?" content="Si necesita ayuda con alguno de los puntos indicados acá u otros del uso de los Servicios contáctanos" buttonText="¡Necesito ayuda!" buttonUrl="/help" /> --- ## Servicios sin autenticación del SII [![Watch video](https://img.youtube.com/vi/rGPDby2d_yA/hqdefault.jpg)](https://www.youtube.com/watch?v=rGPDby2d_yA) --- ## Servicios con RUT y clave tributaria [![Watch video](https://img.youtube.com/vi/9od9KBaCZSY/hqdefault.jpg)](https://www.youtube.com/watch?v=9od9KBaCZSY) --- ## Servicios con firma electrónica [![Watch video](https://img.youtube.com/vi/7iFbR6VXKRs/hqdefault.jpg)](https://www.youtube.com/watch?v=7iFbR6VXKRs) --- Last updated on 21/08/2026