ILIAS REST Plugin

This is a plugin for the ILIAS Learning Management System, which provides a customizable REST API. It is a fork of an open-source project developed by fluxlabs ag, located in Burgdorf, Switzerland (https://fluxlabs.ch).

Warning

This is a modified version of the original REST plugin which contains changes required by the IACUBUS mobile application.

Requirements

• Version: ILIAS 9 or 10
• PHP 8.2+

Installation

• From within your ILIAS directory:

mkdir -p Customizing/global/plugins/Services/UIComponent/UserInterfaceHook
cd Customizing/global/plugins/Services/UIComponent/UserInterfaceHook
git clone https://github.com/Jakub-eAcademy/Ilias.RESTPlugin.git REST

• Update and active REST-Plugin using the drop-down action-menu button
• Open ILIAS Administration > Plugins from the drop-down menu

Features:

• Permission management for resources depending on REST clients using API-Keys
• Full OAuth 2.0 support (see RFC6749) including the grant types:
  • Authorization Code
  • Implicit
  • Resource Owner Password Credentials
  • Client Credentials
• CRUD (Create-Read-Update-Delete) principle for resources
• Easy integration of new REST endpoints possible
• Based on the PHP SLIM Framework
• Tools included (IShell, System Client, API Testing, IScenarios)

Note: Please refer to the wiki. pages for further information.

Example

Retrieve all available routes

curl -X GET https://<your_domain>/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/REST/api.php/v2/util/routes

More examples can be found in the wiki.

License

This project is licensed under the GNU GPLv3 License - see the LICENSE.md file for details.