API-Dokumentation

Wir bieten die von uns aufbereiteten Vertretungsplan-Daten zusätzlich als API an, um Interessierten einen einfachen Zugang zu ermöglichen, ohne die Daten aufwendig selber parsen und verarbeiten zu müssen.
So können interessierte Schüler oder Eltern die Daten für eigene Projekte verwenden, zum Beispiel eigene Benachrichtigungen oder Statistiken.
Die API ist kostenlos, erfordert aber eine Authentifizierung via API-Key. Dieser ist für 6 Monate (1 Schulhalbjahr) gültig und kann jederzeit erneuert werden.

🚀 Quick Start

Base URL

https://vp-lgka.de/api/

Beispiel-Request

curl -H "X-Api-Key: XXXXXX" https://vp-lgka.de/api/

🔑 API-Key beziehen

📡 Endpunkt: GET /api/

Gibt die aktuellen Vertretungsplan-Daten für heute und morgeni "Heute" und "Morgen" sind beim Vertretungsplan des LGKA nicht immer wirklich Heute und Morgen, sondern sie bezeichnen schlicht den aktuellen/nächsten und den darauffolgenden Schultag. zurück, sowohl als Rohtext direkt aus dem PDF geparst, als auch zu strukturiertem JSON verarbeitet.

Beispiel-Antwort

{
    "code": 200,
    "status": "success",
    "message": "OK: All data available for heute and morgen",
    "payload": {
        "heute": {
            "raw": "...",
            "structured": [...]
        },
        "morgen": {
            "raw": "...",
            "structured": [...]
        }
    },
    "timestamp": "2025-11-10 00:57:09"
}

📊 HTTP Status Codes

Code	Status	Beschreibung
200	`success`	Alle Daten (`raw` und `structured`) für heute und morgen verfügbar
206	`partial`	Teilweise Daten (nicht alle Tage und/oder Formate) verfügbar
401	`fail`	Nicht autorisiert: Ungültiger oder fehlender API-Key
404	`fail`	Keine Daten verfügbar
405	`fail`	Methode nicht erlaubt (nur GET unterstützt)
503	`error`	Service vorübergehend nicht verfügbar (Wartung oder Serverfehler)

🏗️ Datenstruktur

Rohtext (`raw`)

Formlose Darstellung des Vertretungsplans, ungefiltert direkt aus dem PDF geparst.
Enthält Kopfzeilen, Zusatzinfos und Einträge im plain-text.

Strukturiert (`structured`)

Einzelne Vertretungsplan-Einträge als verarbeitetes und aufbereitetes JSON.i structured ist vom Typ:
[{"": "" | null, ...}, ...]
Jeder Eintrag enthält:

Feld	Typ	Beschreibung
`art`	string	Art der Änderung (z.B. "Entfall", "Vertretung", "Verlegung")
`stunde`	string	Betroffene Stunde(n) (z.B. "7", "5-6", "1-11")
`klasse`	string	Betroffene Klasse (z.B. "7a", "8acd", "J11")
`lehrer`	string \| null	Vertretungslehrer (wenn vorhanden)
`fach`	string \| null	Vertretungsfach (wenn vorhanden)
`raum`	string \| null	Vertretungsraum (wenn vorhanden)
`fach_alt`	string	Ursprüngliches Fach
`lehrer_alt`	string	Ursprünglicher Lehrer
`raum_alt`	string	Ursprünglicher Raum
`text`	string \| null	Zusätzliche Informationen (z.B. "Ausflug")

🔐 Authentifizierung

Für alle API-Anfragen ist ein gültiger API-Key erforderlich. Dieser kann auf verschiedene Weise übermittelt werden:

Methode	Format	Beispiel
URL Query Parameter	`?token=XXXXXX`	`https://vp-lgka.de/api/?token=abc123`
Authorization Header	`Authorization: Bearer XXXXXX`	`Authorization: Bearer abc123`
Authorization Header	`Authorization: ApiKey XXXXXX`	`Authorization: ApiKey abc123`
Custom Header	`X-Api-Key: XXXXXX`	`X-Api-Key: abc123`

🔑 API-Key beziehen

Du hast schon einen API-Key und willst diesen erneuern oder löschen? Dann trag ihn hier ein:

💻 Code-Beispiele

📜 JavaScript (Fetch)

fetch("https://vp-lgka.de/api/", {
    headers: {"X-Api-Key": "XXXXXX"}
})
    .then(res => res.json())
    .then(data => {
        console.log(JSON.stringify(data, null, 4));
    });

🐍 Python (requests)i Die requests library muss erst installiert werden: `pip install requests`

import json
import requests as req

headers = {"X-API-Key": "XXXXXX"}
response = req.get("https://vp-lgka.de/api", headers=headers)

data = response.json()

print(json.dumps(data, indent=4))

🔗 cURL Beispiele

Mit Custom Header

curl -H "X-Api-Key: XXXXXX" \
     https://vp-lgka.de/api/

Mit Authorization Header

curl -H "Authorization: Bearer XXXXXX" \
     https://vp-lgka.de/api/

Mit URL Parameter

curl "https://vp-lgka.de/api/?token=XXXXXX"

Support & Kontakt

Bei Fragen zur API oder Feature Requests kontaktiere uns gerne.

Zurück zur Startseite 📧 Schreib uns eine E-Mail

Disclaimer

🤝 Zuverlässigkeit:

Aufgrund von verschiedenen Faktoren können wir keine Verfügbarkeit, Richtigkeit oder Vollständigkeit garantieren.
Die Nutzung erfolgt auf eigenes Risiko. Wir übernehmen keine Haftung für Schäden, die durch die Nutzung entstehen könnten.
Trotzdem sind wir daran interessiert, einen zuverlässigen Service und eine möglichst angenehme Nutzererfahrung bereitzustellen.

Mehr erfahren

VP-LGKA API Dokumentation