mgvo-public/mgvo-api

description

v1.0.2 2024-02-27 15:21 UTC

Requires

• php: >=7.4
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• ext-openssl: *

MIT

• Dirk Hartkopf
• Michael Kours
• Felix Schnabel

README

Dieses Repository stellt den Code für einen externen Zugriff auf MGVO über eine API bereit.
In der Datei MgvoHpApi.php ist die eigentliche API.
In der Datei MgvoSniplet.php befinden sich Funktionen, die auf der API aufbauen und fertige HTML-Sniplets zur Integration in eine Homepage anbieten.

Hierauf aufbauend gibt es auch ein fertiges Wordpress-Plugin, welches die Sniplets entsprechend einbindet. Durch Anpassung nur in den Sniplets kann ohne tiefes Wordpress Wissen sehr leicht eine individuelle Wordpress-Integration vorgenommen werden.

Installation

Die Dateien werden in ein Verzeichnis auf dem Server kopiert.

Test

Die Dateien im Verzeichnis /test enthalten Beispielcoding, um die API zu instanziieren und jeweils eine Methode aufzurufen. Die Methoden können als Vorlage für eine eigene Implementierung dienen.

Sicherheit

Es werden teilweise Funktionen bereitgestellt, die eine höhere Anforderung an die Datensicherheit haben.
Zur Nutzung dieser Methoden muss im System ein geheimer Schlüssel unter "System → Basiseinstellungen → Allg. Parameter", Technik hinterlegt werden.
Dieser Schlüssel wird bei der Instanziierung der API-Klasse als Parameter mitgegeben. (Im Wordpress-Plugin müssen diese Angaben auf den Einstellungsseiten hinterlegt werden.)