Overview API

Endpoint – is a URL on the web server of the "Incoplax" system that addresses a resource and unambiguously corresponds to it. The entire set of endpoints in the REST API forms a tree.

Each endpoint with need to be located in exactly one partition.

The resources provided by the system through the web server are divided into public and private resources. In particular, all static files (www directory) supplied with the distribution are public files. Additional public resources can be added to each domain via the /rest/v1/fs/targets/www API, accessible to all by url /public/<DOMAIN>/…​. Some types of metadata, icons, logos, and default values for web applications are public. Certain types of resources available through the API can be added to the public section by creating roles and granting them access to the corresponding Endpoints, specifying the allowed operations.

Resources that are available to all authorized users. These resources include Endpoints that provide information about the connection, the user, and their roles. Such resources include, in particular, static files of role-based applications loaded in the domain. Similarly, some resources can be added to this category by creating roles and granting them access to the respective Endpoints, specifying the allowed operations.

Other resources are considered private and access to them depends on the role composition of the authorized user.

To use the API, you must be authorized. In response to an authorization request, the server creates a session and sets a cookie with a limited lifespan. Periodically when the web server is accessed, the session lifetime is extended and the lifetime is also updated cookie. Requests within a web socket authorized under the same session also extend its lifetime, but however do not affect the lifetime of the session cookie. The number of concurrent sessions created by a single user is limited to 10 by default, and can be changed in the user properties. If there are not enough sessions, a failover is performed, but a preliminary attempt is made to clear "hanging" sessions that should have been renewed with active applications but have not been renewed for too long.

The sections are structured in a sequence corresponding to the priority of resources placed in them. If a resource can be correlated to more than one section based on its characteristics, it is placed in a higher priority section.