IFRAME-API¶

Mittels der IFRAME-API können Sie eigene Inhalte nahtlos in LiveConfig integrieren und somit dessen Funktionen erweitern. Dies erfolgt durch das Einbetten externer Inhalte in die LiveConfig-Oberfläche über ein <IFRAME>-Tag. Die externe Webseite erhält via CGI-Variablen Informationen zum jeweils angemeldeten Benutzer.

„Eigene Links“ erstellen¶

Melden Sie sich in LiveConfig an und gehen Sie auf Verwaltung -> LiveConfig -> Eigene Links. Die hier erstellten Links sind für alle Benutzer der selben Verwaltungsebene sichtbar, sowie für alle eigenen Kunden (also nicht für die Endkunden von Wiederverkäufern!).

Abschnitte verwalten

Alle eigenen Links werden in Abschnitten verwaltet (was den Abschnitten im Navigationsmenü entspricht). Daher müssen Sie mindestens einen Abschnitt für die Verwendung eigener Links anlegen. Die Optionen für einen Abschnitt sind:

Titel: der Titel des neuen Abschnitts (wird so im Navigationsmenü angezeigt)
URI: der URI-Pfad für diesen Abschnitt (es sind nur Buchstaben, Ziffern, Punkt, Bindestrich und Unterstrich erlaubt). Die vollständige URL zu einem eigenen Link wird zusammengesetzt aus: /liveconfig/ext/ + <Abschnitt-URI> + / + <Link-URI>.

Links verwalten

Die Optionen für eigene Links sind:

Abschnitt: Abschnitt in dem dieser Link angezeigt werden soll
Icon: Icon für die Anzeige im Navigationsmenü
Titel: Titel des Links (zur Anzeige im Navigationsmenü)
URI: URI-Pfad für diesen Link (siehe oben)
Reihenfolge: für die Sortierung mehrerer Links innerhalb des selben Abschnitts
Ziel-URL: die komplette URL welche innerhalb eines <IFRAME> geöffnet werden soll. Dies muss eine HTTPS-URL (SSL) sein, ansonsten öffnen Browser diese aus Sicherheitsgründen nicht („mixed content“). Die URL darf auch keine CGI-Parameter enthalten, da LiveConfig automatisch einige Parameter anfügt (siehe nächster Abschnitt).
Passwort: das Passwort für die Prüfsumme beim Aufruf der Ziel-URL (siehe nächster Abschnitt).

Bemerkung

Aus Gründen der Usability und der Sicherheit ist es nicht möglich, eigene Links direkt auf externe Inhalte innerhalb des Navigationsmenüs verweisen zu lassen (wie z.B. zu Webmail oder phpMyAdmin). Wenn Sie einen Link auf externe Inhalte bereitstellen möchten, müssen Sie immer eine separate <IFRAME>-Seite darstellen, welche diese Links enthält (siehe Beispiel).

Erstellung eigener Inhalte¶

Wenn auf eine Eigene Links-Seite geklickt wird, erstellt LiveConfig einen <IFRAME> welcher die konfigurierte Ziel-URL enthält. Dieser IFRAME hat eine Breite von 100%, die Höhe wird mittels JavaScript auf die Höhe des eingebetteten Inhalts skaliert, so dass normalerweise kein zweiter Scrollbalken erscheinen sollte.

Beispiel-Code steht unter https://github.com/LiveConfig/iframe-api bereit.

Bei der Gestaltung der einzubettenden Inhalte sind fast keine Grenzen gesetzt. Lediglich ein paar Dinge müssen beachtet werden:

Einbinden von lc-iframe.css und lc-iframe.js

Um die Größe des IFRAME automatisch anzupassen, müssen diese beiden Ressourcen direkt vom LiveConfig-Server eingebunden werden.
CGI-Parameter sid, ts und chk

LiveConfig fügt die CGI-Parameter sid (Session-ID des LiveConfig-Benutzers), ts (aktueller Zeitstempel) und chk (Prüfsumme) automatisch an die aufzurufende URL hinzu. Mit der Prüfsumme können Manipulationen an den CGI-Parametern schnell erkannt werden. Mit Hilfe der Session-ID kann ein REST-API-Aufruf prüfen, ob der Benutzer noch angemeldet ist - dabei werden auch weitere Informationen wie etwa der Benutzername, der vollständige Name und eine Liste aller zugewiesenen Accounts zurückgeliefert.

Wir stellen hierfür eine PHP-Include-Datei (lc-api.inc.php) bereit, welche sich um die Session-Prüfung kümmert. Alles was Sie noch benötigen ist ein API-Schlüssel (Lese-Zugriff ist ausreichend).

Wenn Sie in eingebetteten Seiten eigene Eingabeformulare erstellen, ist es am besten diese CGI-Parameter mit durchzureichen, so dass Sie die Gültigkeit der Session zu jedem Zeitpunkt prüfen können. In komplexeren Anwendungen können Sie auch Ihre eigene PHP-Session für diesen Besucher erstellen und diese CGI-Parameter in den Session-Daten speichern-

Für ein vollständiges Beispiel werfen Sie einen Blick auf demo.php in dem Beispiel-Paket (siehe oben).