Can I view the API using an exporer?

The web service is documented in this manual but can also be used interactively.
This is what we call the explorer.
We advice the user to use simple calls while using the explorer. Some of the more advanced calls require the construction of objects and/or arrays.
For actual development and checking during development we advice to use the development tools, or tools like restclien or curl.

Location

The API Explorer can be reached through http://<YOURDOMAIN>/api/rest/explorer/.

In the API Explorer, each main method (GET/POST/PUT/DELETE) has its own colour. Each entity and method can be unfolded. Other documentation is displayed, including the option of giving the API the necessary input.

Using the Try it out button invokes the API from your own system.
After that, both the Request and the Response will be displayed.

Logic / Business rules

With the Explorer, you're working with an actual system! That means that the Explorer adapts to the user's level.
See also the [[text_link link_to="1202" link_text="rights"]] section in this manual.

The logical consequence is that, in the first instance, only public methods and entities will be displayed. Methods requiring rights will be invisible.

However, using the same Explorer, the user is able to log in and so assume another rights level. This can be carried out through the entity/user.

Generally speaking, after method /user/login (and a valid password), more methods will be displayed.