Está en la página 1de 12

LG FMS for SIRCI in Bogotá, Colombia

Smart Report – Material – Generación de Reportes


BFMS-PM-OP-02

Ver 1.1

Fecha: 17 / Enero / 2024

Preparado por : LG CNS


Agenda
• FMS External API
• Consumo de APIs en Swagger
• Py (+code)

• ¿Qué es Swagger?
• Generación de tokens (+script)
FMS External API
• URL
• Contents (Categrys…)
• Total count API
• swagger
¿Qué es Swagger?

“Herramienta basada en la OpenAPI


Specification (OAS) que permite
describir la estructura de tus APIs
para que las máquinas puedan
leerlas.”
Generación de Tokens – Herramientas

• Para utilizar la gran mayoría de los


endpoints, es necesario generar un
token.
• La manera más simple es utilizar un
sistema externo como Postman o
Insomnia.
Generación de Tokens – Variables de entorno

• El proyecto cuenta
con variables de
entorno predefinidas
Generación de Tokens – Variables de entorno

• Cada entorno cuenta con los enlaces, puertos y protocolos predefinidos


• Es necesario añadir variables como user_id y user_password
• Si se desea utilizar Postman para hacer todas las peticiones,
automaticamente este tomará el token.
Generación de Tokens – Localizar token

• El token se podrá
encontrar en los
encabezados de la
respuesta de Login.
• En caso de necesitarlo
en otra plataforma,
copiar el token.
Consumo de APIs en Swagger – Autorización

• Es necesario
autenticarse para
ejecutar las peticiones
desde la aplicación.
Para ello, es necesario
agregar el token.
Consumo de APIs Swagger – Autorización

Se debe añadir el token en


el valor para que Swagger
entienda que se ha
autenticado un usuario a la
aplicación.
Consumo de APIs en Swagger – Petición
• Todas los endpoints de
una API tienen una
opción para probarlos,
esta se llama Try it out.
• Dependiendo del tipo
de petición esta contará
con un cuerpo o
parámetros, estos
deben ser actualizados
si son requeridos para
el endpoint.
Consumo de APIs en Swagger – Petición
• Después de ejecutar la
petición, esta mostrará
una respuesta, exitosa
o errónea (Dependerá
de cómo se haya
configurado)

También podría gustarte