Web API
Die Aufgaben des Web-API umfassen:
- die Registrierung von Benutzern (Anmelden, Ummelden, Abmelden),
- das Benutzen von Services (Authentifizieren, Weiterleiten, Durchreichen) sowie
- ein fertiges Backoffice zur Verwaltung der Datenbank (Ändern von Benutzerdaten durch einen Admin).
Die Web-API wird üblicherweise über ein kleines FastCGI-Skript angesprochen. Dieses Skript lädt die verwendeten Module aus ECCE Roma und initialisiert sich gemäß einer vorgegebenen Konfigurationsdatei. Der Aufruf erfolgt dann über Web:
.../cgi-bin/ecceroma.fpl?<parameter>
Der Kunde hat bei der Gestaltung der Seiten sämtliche Designfreiheiten. Vorgegeben sind lediglich einige (versteckte) Formularfelder. Die Template verwenden eine einfache aber mächtige Templatesprache bei der Perl-Variablen oder Methodenaufrufe im HTML-Code stehen. Darüber hinaus trennt ECCE Roma strikt zwischen Webseiten und Programmcode.
Die HTML-Templates können auf dem Rechner liegen, auf dem sich ECCE Roma befindet, aber auch von einem anderen Rechner dynamisch bezogen werden, falls z.B. diese Seiten mit vordefiniertem Content gefüllt sein sollen (Werbung, Navigation, Kurzinfos, etc.), welcher sich ständig ändert und auf dem ECCE Roma Rechner nicht vorhanden ist.
Für den Betreiber der Web-Präsenz stellt sich die Funktionalität von ECCE Roma in zwei Facetten dar: Die Funktionalität bzgl. der Registrierung (Registrieren eines neuen Benutzers, Ändern der Daten sowie Löschen des Benutzers) und die Funktionalität bzgl. der Benutzung eines Dienstes, inklusive der Authentifizierung. Der Betreiber einer Web-Präsenz wird alle Registrierungslinks für alle Diensten über ECCE Roma leiten, ebenso wie alle Links, mit denen die Dienste genutzt werden sollen. Das Web-API bietet folgende Funktionen an (Funktionen aus dem geschützten Bereich sind mit einem * markiert). Die Hauptfunktion wird als Formularparameter ER_Do übergeben (via GET oder POST):
Wert für ER_Do |
| Funktion |
prepareInsertUser |
| Vorbereiten des Formulars für die Anmeldung |
insertUser |
| Anmelden eines neuen Benutzers (in mehreren Stufen) |
prepareUpdateUser* |
| Vorbereiten des Formulars für Datenänderung |
updateUser* |
| Ändern der Benutzerdaten |
prepareDeleteUser* |
| Vorbereiten des Formulars für Abmelden eines Benutzers |
DeleteUser* |
| Abmelden eines Benutzers |
prepareForgotPassword |
| Vorbereiten des Formulars zum Zuschicken der Eselsbrücke |
forgotPassword |
| Verschickt die Eselsbrücke an den Benutzer |
useService* |
| Benutzt der Service eines Plugins |
Weitere Formularparameter können angegeben werden.
- Abb. 4: Die Benutzeroberfläche
Die Web-API umfasst einen besonderen administrativen Bereich: Das Backoffice. Dieses bietet für Administratoren einen direkten Zugriff auf die Benutzerdatenbank. Es ist möglich, Benutzer zu suchen, manuell einzutragen, zu ändern, zu löschen, und ihren Status zu ändern. Alle Vorgänge durchlaufen den Kern von ECCE Roma, so dass alle Änderungen auch in den externen Systemen propagiert werden. Das Backoffice präsentiert sich mit benutzerfreundlicher GUI, so dass sich auch ungeübtere Personen schnell zurechtfinden.
