/**
 * vimotion REST Interface
 *
 * This software is a product of the
 *
 * vimotion GmbH
 * Am Wiesenbach 24
 * 74564 Crailsheim
 *
 * It can be distributed under the following license
 *
 * @license Creative Commons CC BY-NC-ND
 *
 * Changes to this software can be suggested and sent to vimotion to be
 * implemented by vimotion at our own discretion (vim-rest@vi-motion.de)
 */

VREST Plugin:

Installation:

Die VREST Plugin muss entweder aus einem verhandenen Repository nach
<ilias root>/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook
geclont werden oder andersweitig dorthin kopiert werden. Wie jedes andere
Plugin muss es dann in der Pluginverwaltung installiert und aktiviert werden.

Die Schtittstelle benötigt das Composer-Paket akrabat:
sudo -u www-data php ./composer.phar require "akrabat/ip-address-middleware:1.0.1"

Konfiguration:

Bei der Installation wird bereits ein Salt erstellt und auch die restilichen
Grundeinstellungen werden auf vernünftige Werte gesetzt. Hier muss erst einmal
nichts geändert werden.
Unter dem Reiter API-Schlüssel müssen anfangs erst einmal die Routen über die 
entsprechende Schaltfläche aktualisiert werden. Dabei ist darauf zu achten, dass
der Webserver Schreibzugriff auf das VREST-Verzeichnis und die Unterelemente hat.

Anlegen eines Api-Schlüssels (eigentlich ein Client):

Wenn man einen neuen Api-Schlüssel anlegt, ist es gut, wenn man bereits einen
zugehörigen Api-Nutzer angelegt hat (Die Bezeichnungen wurden aus der früheren
REST-Schnittstelle übernommen und sollten nicht mit der vimotion Api verwechselt
werden).
Über die Schlaltfläche 'Api-Schlüssel hinzufügen' kann ein neuer
API-Schlüssel/VREST-Client angelegt werden.

Dabei ist der Api-Schlüssel der Titel des API-Schlüssels mit dem der Client sich
anmeldet.
API Secret und IP-Restriction können leer gelasssen werden.
Das Api User Login + Passwort sind das Login und Passwort des am besten schon
bereits angelegten Benutzers.

Die beiden Checkboxen müssen angeklickt werden und dann sollte die API-Version für
alle neuen Clients auf Version 3 eingestellt werden, außer man möchte einen Client,
der mit der alten Schnittstelle arbeitet einbinden.

Wenn die 'VREST Version 3' ausgewählt wurde, sollte erst einmal abgespeichert werden.
Anschließend können die Routen der Version 3 ausgewählt werden. Die Routen können
einzeln freigegeben werden, um die einzelnen Funktionen der REST-Schnittstelle
freizuschalten.

Die Dokumentation zu den Routen und ihrer Funktionalität ist in der Dokumentation
<ilias_root>/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/VREST/doc/vrest.html
beschrieben.

Die zugrundeliegende Funktionalität der REST-Schnittstelle wird zum allergrößten
Teil durch die API bereitgestellt. Die REST-Schnittstelle übernimmt ist hierbei
nur die Schnittstellen-Funktionalität Authentifizierung/Routing/Parameter-Check
während die API die Funktionalität übernimmt.
Hierbei wird der oben eingetragene Api-Nutzer an der Api angemeldet und alle
benötigten Rechte werden gegen diesen Nutzer geprüft.

Dadurch ist die REST-Schnittstelle zum einen durch die Routen-Auswahl begrenzt und
auch durch die Rechte des Api-Nutzers.