API: Unterschied zwischen den Versionen
Sbiele (Diskussion | Beiträge) |
Sbiele (Diskussion | Beiträge) |
||
| Zeile 10: | Zeile 10: | ||
<cfhttpparam type="url" name="format" value="json" /><BR> | <cfhttpparam type="url" name="format" value="json" /><BR> | ||
</cfhttp><BR> | </cfhttp><BR> | ||
| − | |||
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. | 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. | ||
| − | + | <HR> | |
<cfhttp method="get" url="https://trainexXX.de/KUNDENVERZEICHNIS/api/index.cfm" username="api_User_Name" password="Api_PAsswort" result="res"><BR> | <cfhttp method="get" url="https://trainexXX.de/KUNDENVERZEICHNIS/api/index.cfm" username="api_User_Name" password="Api_PAsswort" result="res"><BR> | ||
| − | <cfhttpparam type="url" name="m" value="students" /> | + | <cfhttpparam type="url" name="m" value="students" /><BR> |
| − | <cfhttpparam type="url" name="course" value="BABW05VZ" /> | + | <cfhttpparam type="url" name="course" value="BABW05VZ" /><BR> |
| − | <cfhttpparam type="url" name="mat" value="" /> | + | <cfhttpparam type="url" name="mat" value="" /><BR> |
| − | <cfhttpparam type="url" name="format" value="csv" /> | + | <cfhttpparam type="url" name="format" value="csv" /><BR> |
| − | </cfhttp> | + | </cfhttp><BR> |
| + | Ergebnis:Gibt die Studierenden des Studienganges BABW05VZ im csv-Format aus. | ||
| + | <HR> | ||
| + | course, mat und format können auch als URL-Variable übergeben werden. | ||
| − | + | Ein Output eines Studierenden im JSON-Format kann wie folgt aussehen. | |
Version vom 4. Januar 2021, 14:49 Uhr
Die API (application programming interface, wörtlich ‚Anwendungsprogrammierschnittstelle‘) ermöglicht, dass anderen Programme lesend an TraiNex angebunden werden. Diese Schnittstelle zur Programmierung von Anwendungen kann von berechtigten Programmiereren der Hochschule genutzt werden, um Daten in strukturierter Form aus den TraiNex-Datenbanken auszulesen. Die Aktivierung der API erfolgt auf Wunsch durch TrOn und ist eine der Zusatzleistungen.
Die API wird aufgerufen über eine externe Seite, z.B. php, html oder ColdFusion. 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.
course, mat und format können auch als URL-Variable übergeben werden.
Ein Output eines Studierenden im JSON-Format kann wie folgt aussehen.
