Eocortex API, SDK and REST API🔗

Eocortex provides open and free-to-use API, SDK, and REST API, which allows third-party developers to expand the functionality of Eocortex, as well as provide one-way or two-way communications between Eocortex applications and third-party software.

Eocortex API

Eocortex API is the basic set of application programming interfaces provided by Eocortex that allows to build one- or two-way interactions between Eocortex applications and third-party applications. Eocortex API supports and uses various types of requests and responses: HTTP, RTSP, XML, JSON. Eocortex API allows external applications to interact with the Eocortex Server or Client to perform the following tasks, such as:

  • Receiving live view and archive recordings of cameras connected to the system.

  • Receiving various information from the Eocortex Server, including system configuration and entries of Events log.

  • Sending various commands for execution by Eocortex Server or Client.

Eocortex SDK

Eocortex SDK is the set of materials useful in development of external plugins and modules for expanding the existing functionality of Eocortex applications. This development kit is intended for .NET developers and contains the list of core classes and interfaces, as well as several code samples that demonstrate the implementation of external plugins. All source files are written in C#. It is recommended to use Microsoft Visual Studio as a plugin development environment.

Eocortex REST API

Eocortex REST API is the set of advanced application programming interfaces provided by Eocortex that allows to build a deeper interaction with Eocortex than Eocortex API.

Eocortex REST API allows to:

  • Configure cameras, users, groups, views, automation scenarios and some intelligent modules.

  • View the information about statuses and current configuration of servers and cameras.

  • View the list of integrated cameras supported in the system.

  • Manage databases of intelligent modules: add, modify, delete groups and entries for faces and license plates.

Eocortex REST API can be used for system configuration without the need to use Eocortex Configurator and Eocortex Client applications.

The configure/ set of commands is available only for Eocortex systems with Enterprise and ULTRA licenses. Only the user with the highest level of access rights, i.e., belonging to the Senior administrators group, can configure the system using Eocortex REST API.

The api/ set of commands available for all users and for all types of Eocortex licenses.

Note

Detailed descriptions for Eocortex API, SDK and REST API are available at the website eocortex.com, on the Support / Documentation page.

The Eocortex REST API description is also available for viewing in the browser using Swagger if configured accordingly.

Note

Eocortex Software Development Kit (plugin samples written in C#) can be downloaded at the Download page of the eocortex.com website. Specific plugin samples can be provided by request. Eocortex SDK is not required to use Eocortex APIs resources.