mgvo-public/mgvo-api

description

Maintainers

Details

gitlab.com/mgvo-public/mgvo-api

Homepage

Source

Issues

Installs: 66

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Forks: 1

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

Requires

MIT aeef83002ee7a6c31dd97dbba3fab9dd2b1be02f

  • Dirk Hartkopf <d.hartkopf.woop@ibb.solutions>
  • Michael Kours <git.woop@m-bihn.de>
  • Felix Schnabel <fschnabel.woop@eclipso.de>

This package is auto-updated.

Last update: 2024-05-26 11:37:23 UTC

README

Dieses Repository stellt den Code für einen externen Zugriff auf MGVO über eine API bereit.
In der Datei mgvo-hpapi.php ist die eigentliche API.
In der Datei mgvo-sniplets.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.

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.)