API overview
Endpoints
An endpoint is a URL on the web server of the «Incoplax» system that addresses a resource and uniquely corresponds to it. The entire set of endpoints in the REST API forms a tree.
Each endpoint is necessarily located in exactly one section.
Resource categories and access procedure
Resources provided by the system through the web server are divided into public and private.
Public ones include, in particular, all static files (the www directory) supplied with the distribution.
In each domain, additional public resources accessible to everyone at the URL /public/<DOMAIN>/… can be added via the API /rest/v1/fs/targets/www.
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 with the allowed operations specified.
Resources available to all authorized users. These include endpoints providing information about the connection, the user, and their roles. These include, in particular, static files of role applications uploaded to the domain. Similarly, some resources can be added to this category by creating roles and granting them access to the corresponding endpoints with the allowed operations specified.
Other resources are considered private; access depends on the role composition of the authorized user.
To use the API, authorize first. In response to an authorization request, the server creates a session and sets a cookie with a limited lifetime. Periodically, when accessing the web server, the session lifetime is extended and the cookie lifetime is also updated. Requests within a WebSocket authorized under the same session also extend its lifetime but do not affect the cookie lifetime. The number of simultaneous sessions created by one user is limited to 10 by default and can be changed in the user properties. If sessions are insufficient, a refusal is returned, but first an attempt is made to clear "hanging" sessions that should have been extended with active applications but have not been updated for too long.
/api requests without a session can pass credentials in the domain, login, pwd request parameters; no session is created in this case.
The td parameter is a deprecated synonym for domain: if both are passed, td is considered the login domain and domain remains a command parameter.
REST API sections
The section structure is given in the sequence corresponding to the priority of resource placement. If a resource, by its characteristics, can be attributed to several sections, it is placed in the higher-priority one.
-
-
design
Selected functional API sections
-
Configuration master management
-
Monitoring
-
Health check (without authorization)
-
Rule testing
-
External authorization and identification (OAuth 2.0 and OpenID Connect 1.0)
-
Token request handling