Examples

Retrieve all available routes

Assuming you managed to install the REST-Plugin in a localhost environment, then invoking the following command should give you a list of routes:

curl -X GET http://localhost/Customizing/global/plugins/Services/UIComponent/UserInterfaceHook/REST/api.php/v2/util/routes

OAuth2 Flows

Examples for all supported OAuth2 flows are implemented in the OAuth2 Demo located under tools.

Using Routes

Additionally the Admin- and Checkout-Application located unter apps and easily reachable from the ILIAS plugin configuration screen implement authentication as well as using routes that require authentication.

Tools

There are some tools that should make working with and debugging the REST-Plugin easier:

• RESTClient is a minimal client written in php that can be used to fetch access-token and issue requests
• shell is a small ipython based script that automates access-token generation so you can focus on sending requests without first doing an OAuth2 authorization flow first
• Advanced REST Client is a useful application for the chrome browser that can send and save REST-Requests