red-saldo-API

Microservicio creado con Node para obtener datos de la red metro en un formato amigable. (Chile)

📝 Prerrequisitos

- Tener NodeJS instalado en tu equipo.

📝 Instrucciones

El servidor requiere de autorización JWT para funcionar, para esto se debe hacer un archivo .env con las siguientes variables

SECRET_KEY="" // clave secreta
AUTHORIZED_TOKEN_GENERATION="" // clave alfanumérica para generar el token, se debe hacer un POST a localhost:3000/api/generartoken enviando auth_token en un body
MAX_TIME_TOKEN="" // tiempo máximo que dura el token generado anteriormente

Para ejecutar el servidor de express (index.js:)

npm run api

Para obtener un .json con los datos de la tarjeta debe hacer una petición GET a esta ruta:

localhost:3000/api/bip/<numero de tu bip>

Ejemplo:

{
    "respuesta": true,
    "datosTarjeta": {
        "numeroTarjeta": "XXXXXX",
        "tipoContrato": "Contrato Activo",
        "balance": "$110",
        "fechaSaldo": "16/07/2030 15:14"
    }
}

Para obtener datos del estado del servicio de metro se debe hacer una petición GET a esta ruta:

localhost:3000/api/estadored

Ejemplo:

{
    "respuesta": true,
    "estadoRedMetro": {
        "L1": "Línea operativa",
        "L2": "Línea operativa",
        "L3": "Línea operativa",
        "L4": "Línea operativa",
        "L4a": "Línea operativa",
        "L5": "Línea operativa",
        "L6": "Línea operativa",
        "trenNos": "Hay problemas en el servicio"
    }
}

Si hay errores, el estado de 'respuesta' cambiará a false, y aparecerá la key "error" con la descripción del error:

Ejemplo:

{
    "respuesta": false,
    "error": "El parámetro ingresado no cumple con los requisitos para ser aceptada como Bip!."
}