API zu LANiS-Online

Wir werden in nächster Zeit eine kleine API (Schnittstelle) zu LANiS-Online herstellen. Ziel ist es andere Software, aber auch andere Webseiten den Zugriff auf/von LANiS-Online zu ermöglichen und so insgesamt eine vielfältige Welt an Seiten, Tools, Programmen und Apps mit Zugriff von/auf/zu LANiS-Online zu ermöglichen.

Geplante Funktionen, die andere Seiten/Tools/Programme/Apps anstoßen können, sind:

(in grün: Möglichkeiten, was sich damit machen lässt; in rot: Fragen/Bedenken; in gelb: Hinweis)

  • Trust-Token für einen Account abfragen und diesen bei sich speichern (Voraussetzung für die folgenden Aktionen)
  • Abfrage, ob in LANiS-Online etwas Neues vorliegt (mit Rückmeldung des Namens des Tools sowie der Anzahl, ggf. der x neuesten Einträge) -> um es bspw. in Moodle oder Schul-App anzuzeigen
  • Direkt-Login in LANiS-Online von fremden Tool aus -> um direkt in LANiS-Online agieren zu können
  • Aktualisierung und Übertragung der Benutzerdaten einer Schule (je nach Funktionsumfang notwendig)  -> wenn bspw. Klassenlisten im Tool benötigt werden ?? bedingt schulbezogene, schul-eigene Klärung des Datenschutzes mit dem Anbieter
  • Push einer eigenen Aktualisierung der Seite/Tools/Programm, um es auf der entsprechenden Kachel für den Direkt-Login aus LANiS-Online anzuzeigen (nur wenn etwas Neues vorliegt, Sammel-Push über alle Benutzer, nur 1x pro 5 Minuten) -> um auf Neues in anderen Tools reagieren zu können

Geplante Schnittstellen, die LANiS-Online bei der anderen Seite/Tool/Programm/App bietet:

  • Bereitstellung des Trust-Tokens
  • Direkt-Login in das andere Tool/Seite -> um auch dort direkt agieren zu können
  • Anfrage, ob sich dort etwas geändert hat (1x/h) -> Alternativ zum Push des Neuen (s. oben)

Auf Seiten von LANiS-Online muss sich daher auch noch eine Seite befinden, auf der man

  1. nachschauen kann, welche Trust-Tokens für den Account gerade an welche Anwendung vergeben sind und
  2. diese auch wieder löschen können muss.

Eine Fremdsteuerung der bisher vorhandenen Tools werden wir dabei aus vielfältigen Gründen nicht anbieten können.

Umsetzen werden wir die Schnittstelle mit einem Rest-Service (also einfache HTTP-Requests und JSON-Antworten), da sich beides heutzutage in jeder Programmiersprache gut und einfach umsetzen lässt.

Was würde euch bei einer solchen Schnittstelle fehlen? Wer hätte Lust direkt von Anfang an Zugriff auf diese zu eigenen Testzwecken zu bekommen?

2 Gedanken zu „API zu LANiS-Online

  1. Ich finde das sehr interessant, verstehe allerdings leider nicht das Ziel. Ich kenne eigentlich nur APIs, die direkt lesend/schreibend auf etwas zugreifen, meist auch sehr umfangreich.
    In diesem Fall wollt ihr wahrscheinlich zusätzliche Module unter dem LANIS-Online vereinigen, ohne dass sie miteinander agieren können?

    Grundsätzlich vermute ich sogar eher für euch als Lanis-Entwickler einen großen Mehrwert. Wahrscheinlich lassen sich die diversen Schnittstellen zu Fremdprogrammen (u.a. Stundenplan/Vertretungsplan) leichter damit gestalten.

  2. Das Ziel ist ein deutlich anderes: Durch die direkte API können andere Tools/Webseiten/Apps Direkt-Logins in das Schulportal anbieten und bspw. abfragen, ob und ggf. was es neues gibt. Insofern stände dann der Weg frei, dass eine Schule ihr Moodle um eine entsprechende selbstgeschriebene Erweiterung ergänzt. Oder eben ein Informatik-GK eine APP entwickelt, die mitbekommt, wenn sich im Schulportal für den jeweiligen User etwas Neues ergeben hat. Dadurch schaffen wir es also die Richtung umzukehren: Nicht mehr wir gehen nur Fremdlogins an, sondern bieten gleich noch mehr. Es ist also eine API mit einem (eher) lesenden Zugriff.

    Zudem wäre es möglich über den Weg Login aus dem Schulportal den Weg zu öffnen, dass Fremdsysteme die Benutzerdaten direkt abgreifen können – ohne, dass dort eine erneute Benutzerverwaltung notwendig wird.

    Eine umfangreichere API können wir dabei aus Zeitgründen nicht anbieten. Zudem müssen wir auch erstmal abwarten, ob diese überhaupt genutzt wird (wenn sie denn mal Realität ist).

    Wir selbst haben davon eher nur einen sehr geringen Mehrwert. Weder eine einfachere Agierung von LANiS-Online-Tools, noch ein einfacherer Zugriff auf Fremdschnittsellen ergibt sich dadurch für uns. Lediglich eine Vereinfachung des Informationsflusses und Logins für unsere Nutzer.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.