Page History

HTTP API is represented by web2 module ( module—Web-server 2.0).

...

...

(see Configuring the Server to connect the Clients via the Web-server 2.0 module

...

).

HTTP API allows using the following features:

1. Get information about interactive maps: map list, map name, map layer list, layer parameters, layer background image, information about the list of points and an individual point on the layer (see Map).
   
2. Get information about object classes created on the Server, a list of states for the object class and information about status, icons for a specific state (see  Object classes).
   
3. Get a list of objects created on the server, information about the individual object, the state of the object, the list of available actions with the object (see Objects).
   
4.  Receive events from the Server both separately and by blocks (see  Getting events).
   
5.  Send commands to the server (see  Sending commands to server).
   
6.  Run macros (see Macros).
   
7.  Work with video: get frames, request configuration, receive live and archive video, manage recording, arm and disarm cameras, manage telemetry (see Video).
   
8.  Get live and archive sound (see Sound).
   
9. Get a list of users (see Users).
10.  Send events and reactions to the core of the Intellect software (see  Sending reactions and events to Intellect using HTTP request).

11. Access the Face-Intellect API and the Auto-Intellect API (see Calling API of vertical solutions via Intellect HTTP API).

12. 
    

    Set up integration with Technoserv and ECHD (see Configuring the Technoserv integration).

The following notation is used in the examples shown in this section:

...

Authorization

Authorization is needed for requests. Two types of authorization are supported: Basic and Bearer.

...

With the Bearer authorization type, the token received from the web server is used (see Authorization using a token key).

Default response format

By default, the response is in the JSON format. The default response in XML format can be enabled on the settings panel of the Web server 2.0 object (see Configuring default response type for HTTP API requests). Also, the response format can be explicitly specified in the Accept header, for example application/json or application/xml. The response format specified in the request has a higher priority than the default response format specified on the settings panel of the Web server 2.0 object.

Cross domain requests (CORS)

To perform cross-domain requests or to access the necessary headers in the response (for example, due to CORS browser policy restrictions), it is necessary to specify Origin (the domain of the site from which the request is made) in the request header. In this case, the response will contain the Access-Control-Allow-Origin header, which indicates that the resource can be accessed from the specified domain in a cross-site manner. The Access-Control-Allow-Origin: * header indicates that the resource can be accessed from any domain in a cross-site manner.

Using HTTPS

If it is required to send requests to the API via HTTPS and the use of HTTPS is not enabled in the Web-server 2.0 settings (see HTTPS settings), then use port 8443. In this case, requests will be redirected to HTTP. For example, if you request “https://127.0.0.1:8443/web2/secure/configuration”, it will be automatically redirected to “http://127.0.0.1:8085/web2/secure/configuration”.