Introduction
This document describes the REST interface to ENGINE4, the data structure and how interface applications should be built.
Via this REST/JSON-API it is possible to read and write data in or from ENGINE4. Authentication is performed via OAuth 2.0. For all accesses, the permissions assigned in ENGINE4 are taken into account according to the user's security role.
An example client can be found further down in this documentation under Best Practises.
General notes The ENGINE4 API runs on different SaaS or OnPremise environments. The examples in this document all point to the test environment (SaaS):
The URL for the test environment (SaaS) is:
https://test.engine4.io/externalApiDocs/ The URL for the production development environment (SaaS) is: https://prodapi.engine4.io
For OnPremise installations, use the externally accessible URL!
To use the API, you need a ClientID, a valid account, and information about the relationships of entities and their references to each other. You can obtain this information from your responsible consultant.
The ClientID is an additional factor in authentication. ClientIDs can be defined via "Identityserverkonfiguration" through your Consultant of Mobile Function. It is recommended to create one ClientID per customer/client. The ClientID is considered as an additional parameter to username and password. An assignment of the ClientID to user or client is not necessary.
An account (username and password) is required, which has the necessary rights/roles in the respective system to read or write (or depending on the use case).
It is possible/required to define limitations for API requests for external APIs but also the usage of E4 itself (via the normal user interface). See "Apirequestlog/ Limitationconfig" (MF)
Its necessary that you obtain a license for REST API usage on a regular basis. Your sales manager can support you for this.