API
Inhaltsverzeichnis
Allgemein
Die API (application programming interface, wörtlich ‚Anwendungsprogrammierschnittstelle‘) ermöglicht es, dass andere Programme lesend (oder ggf. in definierten Ausnahmefällen schreibend) an TraiNex angebunden werden. Diese Schnittstelle zur Programmierung von Anwendungen kann von berechtigten Programmierenden der Hochschule genutzt werden, um Daten in strukturierter Form aus den TraiNex-Datenbanken auszulesen (oder ggf. in definierten Ausnahmefällen zu schreiben).
Die Aktivierung der API erfolgt auf Wunsch durch TrOn und ist eine der Zusatzleistungen. Zur Aktivierung erhalten Sie Zugriff auf ein Word-Dokument, das die Details der Nutzung sowie möglich Parameter beschreibt. Die Programmierung auf Seiten der Hochschule muss durch eine zuständige Person der Hochschule erfolgen.
Aufruf der API
Die API wird aufgerufen über eine externe Seite, die außerhalb des TraiNex-Servers, aber in Deutschland, liegt. Die Seite kann in z.B. php, html oder ColdFusion geschrieben sein. In ColdFusion würde der Aufruf z.B. wie folgt aussehen:
<cfhttp method="get" url="https://trainexXX.de/KUNDENVERZEICHNIS/api/index.cfm" username="api_User_Name" password="Api_PAsswort" result="res">
<cfhttpparam type="url" name="m" value="students" />
<cfhttpparam type="url" name="course" value="" />
<cfhttpparam type="url" name="mat" value="12345,testnr" />
<cfhttpparam type="url" name="format" value="json" />
</cfhttp>
Ergebnis: Ruft die Studierenden ("m=students") aller Studiengänge ("course=") mit der Kundennummer "12345" und "testnr" auf und gibt es als JSON (format=json) aus.
<cfhttp method="get" url="https://trainexXX.de/KUNDENVERZEICHNIS/api/index.cfm" username="api_User_Name" password="Api_PAsswort" result="res">
<cfhttpparam type="url" name="m" value="students" />
<cfhttpparam type="url" name="course" value="BABW05VZ" />
<cfhttpparam type="url" name="mat" value="" />
<cfhttpparam type="url" name="format" value="csv" />
</cfhttp>
Ergebnis:Gibt die Studierenden des Studienganges BABW05VZ im csv-Format aus.
Im Standard werden wenig Details vom Studierenden oder Studiengang übergeben. Der Umfang der Details kann durch den Parameter FETCH bestimmt werden.
Wen mehrere Standorte verwendet werden, kann mittels des Parameters BRANCH der verwendete Standort bestimmt werden.
course, mat und format kann die Hochschule natürlich auch als URL-Variable übergeben an die externe Seite.
Sicherheit
Username und Passwort sowie API-ID werden festgelegt durch TrOn und dem Kunden mitgeteilt.
Der Aufruf erzeugt Basic-Auth-Credentials.
Das Zusatz-Passwort wird systematisch und automatisch in definierten Zeitabständen (z.B. täglich) geändert.
An einer Stelle wird dazu von einer zuständigen, programmierenden Person benötigt der Wert day_of_year_heute. Dieser ist z.B. am 20.2. die Zahl 51.
Jede Nutzung der API wird inkl. IP-Adresse registriert/protokolliert. Die aufrufende IP-Adresse kann definiert sein.
Ein Aufruf von außerhalb Deutschlands/Östereichs ist erschwert und nicht automatisch möglich.
Zeiten des Abrufs können festgelegt sein (z.B. nur abends zwischen 18 und 19 Uhr).
Output
Ein Output eines Studierenden im JSON-Format kann wie folgt aussehen.
Ein Output eines Studierenden im CSV-Format kann wie folgt aussehen.
Zusatzfelder
Die API liefert Rohdaten in alternativen Formaten. Zu den Rohdaten gehören die Personal-Daten der Nutzenden wie Name, Geburtsdatum, Studiengruppenzugehörigkeit, Matrikelnummer oder Vorsemester. Der Output enthält nur die in Datenbanken gespeicherten Felder und keine berechneten Felder. Beispiel: Die Anzahl der Vorsemester ist in TraiNex gespeichert und kann direkt abgerufen werden. Die Anzahl der Fachsemester hingegen wird berechnet aus z.B. Studienstart, Studiengangssemester und Vorsemester etc. und kann nicht direkt abgerufen werden.
Ebenfalls nicht direkt abgerufen werden können verbundene Tabellen. Beispiel: Das Modulthema einer Prüfung steht in einer Tabelle und die Noten einer studierenden Person in einer anderen Tabelle. Wenn eine Liste mit "Noten der studierenden Person" über die API abgerufen werden können soll, so ist dies trainexseitig durch TrOn eine der Zusatzleistungen.
Siehe auch
Letzte funktionale Änderungen
- Oktober 2022: API: Möglichkeit, Noten von extern in die Noten-Voreintragstabelle in TraiNex einzutragen
- Oktober 2022: API: Integration des Leistungs-Stands/Einzel-Noten für den Export
- Oktober 2022: API: Möglichkeit, auf erzeugte Noten-Termine-json-Datei von extern zuzugreifen
- August 2021: API: Verbesserung der Anwendungsprogrammierschnittstelle, um Bewerber-Daten auch schreibend in TraiNex einfügen zu können
- Januar 2021: Verbesserung der Anwendungsprogrammierschnittstelle, um TraiNex-Daten automatisch-lesend von anderen berechtigten Anwendungen abfragen und verwenden zu lassen (Beispiel: Matrikelnummer-Namens-Liste)
