skoleintra

NodeJS API for SkoleIntra

Uofficiel API for ItsLearning's SkoleIntra til NodeJS.

Getting started

ForældreIntra er en del af SkoleIntra, som brugers af folkeskoler til kommunikation mellem skole og hjem. Denne NPM pakke logger automatisk på ForældreIntra og kan hente et barns kalender, ugeskema og ugeplaner.

Bemærk at dette bibliotek ikke er udviklet af ItsLearning, men er et uofficielt program. Hvis du oplever fejl må du meget gerne indrapportere dem på Issues.

Biblioteket her er skabt i forbindelse med et ønske om at tilgå Skoleintra automatisk, for at vise skoleskema og ugeplaner på vores hjemme dashboard. Det kan du læse mere om her

Opsætning

Du henter og installerer pakken ved at køre npm install skoleintra

Anvendelse

Biblioteket skal først instantieres med loginoplysninger til ForældreIntra platformen. Herefter kan du kalde forskellige asynkrone metoder til at hente oplysninger fra SkoleIntra siden.

import SkoleIntra from 'skoleintra'

const instance = new SkoleIntra('brugernavn', 'adgangskode', 'https://MIN_SKOLE.m.skoleintra.dk');

const kalendar = await instance.getCalendarActivitiesByMonth(Date.now());

Avanceret brug

Promises

Da alle metoder er asynkrone er returnerer et Promise, er det muligt chaine flere metoder sammen.

Se dette eksempel på at hente skoleskema og efterfølgende ugeplanen for et barn.

import SkoleIntra from 'skoleintra'

const instance = new SkoleIntra('brugernavn', 'adgangskode', 'https://MIN_SKOLE.m.skoleintra.dk');

instance.getWeeklySchedule(new Date()))
  .then((schedule) => {
      console.log(schedule);
  })
  .then(() => instance.getWeeklyPlan(new Date()))
  .then((plan) => {
      console.log(plan);
  })

// Eller med await/async

const weeklySchedule = await instance.getWeeklySchedule(new Date()));
console.log(weeklySchedule);

const weeklyPlan = await instance.getWeeklyPlan(new Date());
console.log(weeklyPlan);

Brug eksisterende cookie

Det hænder af og til at du bliver blokkeret fra automatisk at logge ind. Når dette sker kaster biblioteket den generiske fejl:

Error: Request was blocked by automation protection. Try initializing SkoleIntra with an existing cookie.

For at omgå den blokkering, kan du kalde setCookies() med en cookie-streng, efter at have logget ind første gang i din normale browser. Biblioketet vil stadig automatisk logge ind for dig efterfølgende, men det lader SkoleIntra forstå at du allerede har besøgt deres platform som bruger tidligere og så blokkerer de ikke efterfølgende kald til deres side.

import SkoleIntra from 'skoleintra'

const instance = new SkoleIntra('brugernavn', 'adgangskode', 'https://MIN_SKOLE.m.skoleintra.dk');

instance.setCookies('Pool=nsiu SsoSelectedSchoo...')
  .then(() => instance.getCalendarActivitiesByMonth("2024-02-29"))
  .then((calendar) => {
      console.log(calendar);
  })

// eller med async/await

await instance.setCookies('Pool=nsiu SsoSelectedSchoo...');
const calendarActivities = await instance.getCalendarActivitiesByMonth("2024-02-29"));

console.log(calendarActivities);

Deltagelse og videre udvikling

På nuværende tidspunkt er det muligt at hente et barns aktivitetsekalender, ugeskema og ugeplan for en given dato. Jeg overvejer at udvide til også at kunne hente informationer om flere af ens tilknyttede børn, samt at skrive en driver der gør biblioteket i stand til også at gemme de data den henter fra gang til gang.

Du er også mere end velkommen til at fortsætte udviklingen af biblioteket her og sende dine egne pull requests ind.

Kig også gerne med på issues siden, hvis der skulle være nogle åbne fejlrapporter.

License