Skip to main content

Exploring the API

In order to get up to speed with the REST interface, you can use our interactive API documentation site, which is based on Swagger. This lists the available services and and shows samples for their parameters and results. It also allows you to directly invoke the REST endpoints via a simple mouse click:

The fallback content to display on prerendering

In order to use it, login to iCL Portal as an administrator. Then go to “https://<your.portal.url>/swagger/ui/index”

Note, that you will need to specify an OAuth bearer token in the “Authorization” field in any of the web sevices in order to try them out. This is what the server uses to verify that you are indeed authenticated.

How to retrieve the OAuth 2.0 bearer token