API Mi UTEM

API REST hecha por estudiantes de la Universidad Tecnológica Metropolitana de Chile a base de scrapping a la plataforma académica Mi.UTEM

Para comenzar

Requisitos

• nvm
• yarn
• Node.js LTS

Inicio con docker

Si utilizas docker o prefieres tener un inicio más simple y sin instalar nada, puedes utilizar el siguiente comando para iniciar el proyecto

docker compose up -d

Este comando iniciará el servidor local de la app (y si necesita alguna instalación lo hará automáticamente). Para apagarlo utiliza

docker compose down

Si quieres ver más sobre docker compose, puedes ver la documentación.

Instalar nvm, yarn y Node.js

1. Primero se instalará nvm con el siguiente comando

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash

2. Luego para poder ocupar nvm en la terminal, se deberá agregar al perfil del bash con

source  ~/.bash_profile

3. Teniendo instalado nvm y con acceso correcto desde la terminal, se instalará npm y Node.js con el siguiente comando

nvm install --lts

4. Para asegurarse de estar usando la versión de Node.js recién instalada, se sugiere ejecutar lo siguiente

nvm use --lts

5. Finalmente para habilitar yarn debes de usar este comando (también puedes seguir la documentación de yarn)

corepack enable

Configuración

La configuración del proyecto está determinada por las variables de entorno, las cuales pueden estar configuradas en el sistema o pueden estar en un archivo .env en la raíz del proyecto de la siguiente forma

PORT=443
SENTRY_URL=https://[email protected]/5600920
PRIVATE_KEY_PATH=/etc/letsencrypt/live/miutem.inndev.studio/privkey.pem
CERTIFICATE_PATH=/etc/letsencrypt/live/miutem.inndev.studio/fullchain.pem
MI_UTEM_URL=https://mi.utem.cl
ACADEMIA_UTEM_URL=https://academia.utem.cl
ACADEMIA_CLIENT_SECRET=....
PASAPORTE_UTEM_URL=https://pasaporte.utem.cl
SSO_UTEM_URL=https://sso.utem.cl
GOOGLE_APPLICATION_CREDENTIALS=./mi-utem-inndev-credentials.json
FCM_SERVER_KEY=AAAAPEuk7fI:APA91bGG9UrjuLX8kt1DWVwz...
SISEI_KEY=123456

Variable	Descripción
PORT	Puerto donde correrá el servicio, se utiliza ´443´ para habilitar las consultas ´HTTPS´
SENTRY_URL	URL de Sentry para el manejo de errores
PRIVATE_KEY_PATH	Ubicación del archivo correspondiente a la llave privada del certificado HTTPS
CERTIFICATE_PATH	Ubicación del archivo correspondiente al certificado HTTPS
UTEM_URL	URL de la página web UTEM
MI_UTEM_URL	URL de la página web Mi.UTEM
ACADEMIA_UTEM_URL	URL de la página web de Academia.UTEM
ACADEMIA_CLIENT_SECRET	Token para generar URLs de login del SSO para Academia.UTEM
PASAPORTE_UTEM_URL	URL de la página web de Pasaporte.UTEM
SSO_UTEM_URL	URL de la página web de SSO.UTEM
REQ_REF	Opcional. Valor del parámetro ref que se agregará a las consultas a las distintas webs.
GOOGLE_APPLICATION_CREDENTIALS	Ubicación del archivo de credenciales del proyecto Firebase.
FCM_SERVER_KEY	Llave del servidor de FCM para enviar notificaciones.
SISEI_KEY	Llave para que el equipo de SISEI pueda hacer algunas consultas. Puede ser cualquier valor.

Ejecución

1. Antes de ejecutar el proyecto, se deberán actualizar las librerías y generar archivos necesarios con este comando

yarn install

2. Luego para ejecutar el proyecto con

yarn start

Consultas

Enviar notificaciones

Para enviar notificaciones se debe hacer una consulta PUT al endpoint /v1/notas/notificar. Por ejemplo en caso de apuntar al servidor de SISEI, la consulta sería PUT https://apiapp.utem.dev/v1/notas/notificar.

Es importante que en el body de la consulta vayan los siguientes valores como un JSON (Para eso se debe agregar el header Content-Type: application/json).

PUT /v1/notas/notificar HTTP/1.1
Content-Type: application/json

{
    "rut": "19.649.846-K",              // RUT del estudiante que recibio la nota
    "valor": "5.3",                     // Valor de la nota
    "codigo": "INFB8026",               // Código de la asignatura
    "nombre": "PRACTICA PROFESIONAL",   // Nombre de la asignatura
    "key": "123456"                     // Debe ser la misma que SISEI_KEY en las variables de entorno
}

Obtener token para Academia.UTEM

Puedes solo hacer una solicitud a https://academia.utem.cl/sso (con javascript desactivado), luego ve el código fuente y busca la variable 'keycloak', dentro tiene una configuración credentials.token en formato json. Allí puedes obtener el token.

Créditos

Este proyecto fue creado por el Club de Desarrollo Experimental (Ex Club de Innovación y Desarrollo) y a este repositorio han aportado los siguientes perfiles: