Camlytics user guide

Overview of Camlytics Camera Software, and how to get started with it.

This section is made for developers or integrators who would like to integrate with Camlytics application.

The REST API allows handling analytical events such as motion detected, camera obstructed, etc. in a custom way. For example, you might want to store events in a remote database, send them to a web service or start an external application.
The API also allows you to receive the list of Camlytics channels with complete details - streaming URI, name, etc. This might be helpful if you plan to use your own player to view cameras remotely (via mobile device).

Camlytics provides a very simple and universal way to control all camera events and retrieve channels data. In order to integrate with the application via REST API, complete the following steps:

  • Start the application and make sure you have the latest version (min supported version is 1.2.0)
  • Enable REST API in settings (it is enabled by default).
  • To verify that the REST API is working, add a channel, generate any event (object appear, etc.) and go to http://localhost:48462/v1/json/events?limit=10&timeout=5. If no events are available, an empty JSON array will be returned.
    In case something went wrong, please refer to logs that are located in %APPDATA%\Camlytics\Logs\.
  • For detailed ducumentation, go through autogenerated REST API reference

For additional support contact us at info@camlytics.com

Please find an example that demonstrates how to integrate with Camlytics REST API using JavaScript.

Note that you can use whatever programming language and framework you prefer. The necessary client code can be generated from Swagger definition file which is compliant with Swagger specifications. Please read more about Swagger here.
Online code generation available at SwaggerHub.

It is possible to integrate with Camlytics by writing an add-in on .NET. However, it is discouraged as Native API is deprecated at this time and will be removed in the future. Documentation on Native API can be found here.