School API

an open source API for IServ and Units written in Java

⚠️ Outdated: This API is not fully compatible with the newest version of IServ anymore

This project can either be used as Java libary for accessing units and iserv data, or can be executed as HTTP web API and access data through json.

Features:

Login with your IServ account
Request a given amount of outstanding exercises from iserv
Send mails via SMTP
Read mails via IMAP
Get all examens from calender
Session system
Runnable as web API to use it in JSON format in any language
Request timetable as image from "Units Vertretungsplan"
Request your peronal public profile

How to setup:

As java dependency / libary:

Download the latest release
Unzip it and add the .jar file as dependency in your Java or Kotlin project

As stand-alone http web API:

Download the latest release
Move the .jar file inside the .zip to a new folder
Create a start.sh or start.bat file in the same folder, depending on your OS
Write java -jar <jarname>.jar <port> into the file (replace both variables)
(I'ld recommend to use screen for linux to organize the console)

How to use:

Coming soon...

How to contribute:

Feel free to create a pull request, as long the code style is respected.

Contributers:

DevOFVictory