SPH-API

Inoffizielle API um die Daten des hessischen Schulportals abzurufen

Features

• [x] Stundenplan
• [x] Vertretungsplan
• [x] Mein Untericht
• [x] Nachrichten
• [ ] Lerngruppen
• [ ] Dateispeicher
• [ ] Dateiverteilung

Benutzung

Anmerkung: Für maximale Kompatibilität lassen sich das Verschlüsselungs- und Request-Modul austauschen. Siehe Kompatibilität To-Do

Kompatibilität

Standard-Implementierungen finden Sie hier.

DefaultCrypto-Modul

Struktur:

var crypto = {
    randomUUID: () => {},
    encryptAES: async (value, key) => {}, // Gibt verschlüsselten string (utf-8) zurück
    decryptAES: async (value, key) => {}, // Gibt entschlüsselten string (utf-8) zurück
    encryptRSA: async (value, publicKey) => {} // Gibt verschlüsselten string (base64) zurück
}

Request-Modul

Struktur des DefaultFetchWrapper:

var fetchWrapper = {
    fetch: async (url, options) => {}, // Gibt ResponseObject zurück (Siehe unten),
    getCookie: async (domain, name) => {}, // Gibt Cookie-Objekt zurück (Erforderliche Parameter: value)
    clearCookies: async () => {} // Löscht alle vorhandenen Cookies
}

Struktur des ResponseObject:

var responseObject = {
    defaultObject: response, // Das Objekt, dass normalerweise von der request-/fetch-Methode zurückgegeben wird
    text: async () => {}, // Gibt Antwort als string zurück
    json: async () => {}, // Gibt Antwort als JSON-Objekt zurück
    blob: async () => {} // Gibt Antwort als Blob zurück
}