Capacitación inicial
¿Cómo crear una cuenta en Postman?
Hay que dirigirse al siguiente enlace de Postman y enlazar tu cuenta en la plataforma que se estime conveniente.
¿Cómo crear una colección de API GATEWAY en Postman?
Para poder crear la colección de Postman te debes dirigir a la documentación de API Gateway, y en el costado derecho seleccionar el botón “Run in Postman”.
Importamos la colección en “My Workspace” y seleccionando “Import”
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.
Nota: La ejecución de Postman te derivará a la última versión dependiendo tu sistema operativo.
Una vez creado, se debe configurar Environments y seleccionar “apigateway.cl”, el cual es necesario para pasarle los entornos que se requieren para consumir los servicios ofrecidos.
Environments:
En Environments debes tener configurado inicialmente estos entornos para poder consumir el servicio:
¿Cuáles son los entornos y cómo configurar cada uno?
- APIGATEWAY_URL
- APIGATEWAY_VERSION
- APIGATEWAY_TOKEN
- En APIGATEWAY_URL debe indicarse la dirección de (https://legacy.apigateway.cl)
- En APIGATEWAY_VERSION se debe utilizar “v1”.
- Para obtener el APIGATEWAY_TOKEN se debe entrar con el usuario y contraseña a tu cuenta de API Gateway.
- Te diriges a “Autenticación de API” y luego a “Crear nuevo token”.
- Una vez añadido el nombre del token se debe copiar y guardar de inmediato, ya que solo esa vez podrás ver el Token.
- Este deberá ser añadido en Postman en el entorno de “APIGATEWAY_TOKEN”. (Explicación en la pág. 4,5,6)
Nota: Configurada las variables se debe seleccionar “Save” para que los cambios realizados en el entorno queden guardados.
Colecciones:
Para crear la colección de API Gateway, hay que dirigirse a “Collections” / “API GATEWAY” y luego a “Variables”. Estas serán configuradas a continuación.
Las Variables a configurar son las siguientes:
Ahora añadiremos en “Authorization”, nos dirigimos a “Current Token” y añadimos la variable de {{APISII_TOKEN}}, y seleccionamos “Save” tal como se muestra en la siguiente imagen:
Nota: Estas variables solo permiten consumir algunos de nuestros servicios, como por ejemplo: Contribuyentes/Registros de compra y venta/Documentos tributarios.
Variables:
Los datos deben ser añadidos en “CURRENT VALUE”.
EMPRESA_RUT: Credenciales de empresa en el acceso de la cuenta. En el caso de no ser empresa debes configurar la variable “USUARIO_RUT” y entrar como persona natural.
EMPRESA_CLAVE: Clave de empresa en el acceso de la cuenta.
USUARIO_FIRMA_PUBLIC_KEY: Se debe ingresar la firma electrónica pública, esta se debe copiar la llave pública BEGIN CERTIFICATE que esté junto a la clave privada BEGIN PRIVATE KEY. La forma correcta de enviar la firma es incluyendo los saltos de línea.
USUARIO_FIRMA_PRIVATE_KEY: Se debe ingresar la firma tributaria privada, esta se debe copiar la llave pública BEGIN CERTIFICATE que esté junto a la clave privada BEGIN PRIVATE KEY. La forma correcta de enviar la firma es incluyendo los saltos de línea.
Ejemplo:
¿Cómo ver los datos de mi Firma Electrónica?
En el perfil de tu cuenta de API Gateway encontrarás una opción para ver los datos de la firma.
USUARIO_CLAVE: Se debe ingresar la clave de usuario de SII.
Nota: Configurada las variables se debe seleccionar “Save” para que los cambios realizados en el entorno queden guardados.
¿Cómo utilizo las variables en los servicios?
Los servicios los encontrarás en la siguiente sección como lo muestra la imagen:
Nota: Para que todo funcione correctamente cuando comencemos a realizar pruebas, siempre hay que tener en cuenta que el entorno escogido sea el correcto, es decir que sea el entorno el cual estamos consultando. Como lo muestra en la siguiente imagen:
