@nullx/sigma-academic

SIGMA ACADEMIC API

Module for requesting academic info from SIGMA.

Tabla de contenidos

• Tabla de contenidos
• Sobre este proyecto
• Uso
  • Installation
• Ejemplo
• Licencia
• Contacto

Sobre este proyecto

El código de este repositorio ha sido resultado de un proceso de ingeniería inversa de la app oficial de sigma academic.

Este repositorio ha sido creado con fines únicamente educativos. Cualquier uso de este que infrinja alguna de las normas establecidas por el centro queda bajo su propia responsabilidad.

Uso

El uso de este programa se escapa de mi responsabilidad. Quedará por tanto cualquier uso abusivo de el bajo su propia responsabilidad.

Installation

We will need npm

• npm

npm install npm@latest -g

Installation

1. Install the package

npm install --save @nullx/sigma-academic

2. Usage

import SigmaAcademic from "@nullx/sigma-academic";

const deusto = new SigmaAcademic({
  baseURL: "https://gaude.deusto.es",
  interceptToken: true,
});

async function main() {
  const loginResponse = await deusto.login({
    usuario: "<username goes here>",
    password: "<password goes here>",
  });

  if (loginResponse.errorCode !== 0)
    throw new Error("Login failed: " + loginResponse.mensajeError);
  if (loginResponse.perfiles.length === 0) throw new Error("No profiles found");

  const marksResponse = await deusto.getMarks({
    perfilActivo: loginResponse.perfiles[0].clavePerfil,
  });

  console.log(JSON.stringify(marksResponse, null, 2));
}

main();

• Edit examples/simple.ts with your information.

• npm run build

• node dist/examples/simple.js

• baseURL can be set by setting BASE_URL environment variable.

• interceptToken (automatically save login token) can be set by setting INTERCEPT_TOKEN environment variable.

Ejemplo

Ejecuta los ejemplos de la carpeta examples/

Licencia

Distributed under the MIT License. See LICENSE for more information.

Contacto

Jon Lara - @nullxme

Project Link: https://github.com/nullxx/sigma-academic