Skip to content

Latest commit

 

History

History
executable file
·
40 lines (29 loc) · 1.48 KB

README.md

File metadata and controls

executable file
·
40 lines (29 loc) · 1.48 KB

ILIAS REST Plugin

This is a plugin for the ILIAS Learning Management System, which provides a customizable REST API.

Installation

  • From within you ILIAS directory:
mkdir -p Customizing/global/plugins/Services/UIComponent/UserInterfaceHook
cd Customizing/global/plugins/Services/UIComponent/UserInterfaceHook
git clone https://github.com/hrz-unimr/Ilias.RESTPlugin.git REST
  • Open ILIAS Administration > Plugins from the drop-down menu
  • Update and active REST-Plugin using the drop-down action-menu button

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://ilias.uni-marburg.de/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/REST/api.php/v2/util/routes

More examples can be found in the wiki.