API: Unterschied zwischen den Versionen
Sbiele (Diskussion | Beiträge) |
Sbiele (Diskussion | Beiträge) |
||
| Zeile 1: | Zeile 1: | ||
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 (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 Nutzer mit der Kundennummer "12345" und "testnr" auf. Das Ergebnis wird als JSON | ||
Version vom 4. Januar 2021, 14:24 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 Nutzer mit der Kundennummer "12345" und "testnr" auf. Das Ergebnis wird als JSON
