How to configure the REST API?
The REST API provides a standarized way of communicating with other applications.
How to setup?
- Define a REST API for your application
Go to Deployment - REST API Settings. Here you can define a REST API by selecting a REST API version and an Application Branch. Hand over the name of the setting - Define credentials for you REST API user
Go to Deployment - API Credentials. Here you can choose a login name and a password for the user of the REST API. Select a user group. As 'Type' select 'Login from REST API'.
Next, hand over this information to the developer of the application that uses the REST API. The name of the setting should be used as variable VERSION in the API documentation. The credentials (login name and password) are used to login.
Documentation of the REST API
To inform the developer about the content of the REST API, specific documentation is available by using this request: /engine?service=application&cmd=getapidoc.This provides the REST API documentation for the current user.
Each class in the application can be provided with additional documentation. You can do this at the class details on the tab "Other settings", paragraph "Advanced", property "REST API Description". The additional documentation will automatically be included in the REST API documentation.