Eocortex API and SDK🔗

Eocortex provides open API (REST API and HTTP API) and SDK that allow third-party developers to extend the functionality of Eocortex and enable one-way or two-way communication between Eocortex and third-party applications.

Note

Detailed descriptions for Eocortex API and SDK are available at the doc.eocortex.com website, on the Documentation for download page.

The Eocortex REST API documentation is also available for viewing in a browser using Swagger if the appropriate setting is enabled.

Eocortex Software Development Kit (plugin samples written in C#) is available upon request. Eocortex SDK is not required to use Eocortex APIs resources.

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.

HTTP API🔗

The Eocortex API component, historically known as the HTTP API, allows access to the Eocortex server to perform the following tasks:

  • receive real-time and archived video streams;

  • receive various information from the Eocortex server, including system configuration and event logs;

  • send a series of commands to perform various actions on the Eocortex server.

Eocortex REST API🔗

Note

The api/ resource is available to all users in any Eocortex product.

Eocortex REST API allows to:

  • Configure cameras, users, groups, screen profiles, certain automation scenarios, and the people counting module.

  • View information about the status of servers and cameras, as well as supported camera models.

  • Manage face databases: receive, add, and edit records for individuals and groups.

The configure/ resource is only available 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.

Eocortex REST API can be used to configure the system without using the Eocortex Configurator and Eocortex Client applications.

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.