System APIs unlock data from the core systems of record within an organization.
The System API page will display the Swagger-UI, which takes an existing JSON or YAML document and creates interactive documentation.
Please check the server list at the top.
|Click this button to authorize yourself to gain access to Swagger.
|Select a method name to expand the section.
Gain access to Swagger.
Bearer Authentication (token authentication) is an HTTP authentication scheme involving security tokens called bearer tokens. The name "bearer authentication" can be understood as "giving access to the bearer of this token." The token is a cryptic string usually generated by the server in response to a login request. The client must send this token in the Authorization header when requesting protected resources.
|To authorize yourself, copy and paste the value found in API Tokens.
Use Swagger. Any action method in controllers can be tested from the user interface. Select a method name to expand the section.
The executed response will be listed at the bottom.
|Try it out
|Click this button to unlock the fields necessary to fill out.
|Fill out the necessary fields
|Add all the required parameters. Parameters differ depending on the catalog you want to test. It can be a password, e-mail, etc.
|Click this button to execute the HTTP response.
Click on Cancel to cancel the action.