Video API Platform

Why did Eagle Eye Networks develop API v3?

API v3 is a REST API that was designed in accordance with the latest standards and best practices. Its new architecture and interactions make it faster and more reliable, particularly for managing large accounts with thousands of cameras. Each API comes with a detailed specification (Open API) to ease the development process. Additionally, the Video and Audio SDK in API v3 can significantly streamline and expedite the development process.

Is it possible to access the legacy Eagle Eye API v2?

Yes, It is possible. The Eagle Eye API v2 is accessible via Legacy APIs.

What new possibilities does API v3 offer?

API v3 brings forth several unique capabilities, including:

OAuth 2.0 Authentication for robust and secure authentication.
Two-way audio to send and receive voice at the site.
RTSP support for recorded and live video.
Floor plan integration to visually represent the location and viewing angles of cameras.
Pagination, which is essential for managing large accounts.
PTZ preset functionality.
And much more!

Can existing integrations with API v2 work with API v3?

No, API v3 differs entirely from API v2, from the endpoints to the response formats. Integration with API v3 must be started from scratch.

Is it possible to mix API v2 with API v3 in my integration?

Mixing the two APIs is strongly discouraged, as it would create a significant complexity for authentication and making requests to the endpoints. It can slow down the API response time and increase the likelihood of errors.

What is required to begin integration with API v3?

You need Client Credentials to start the integration with API v3. Client Credentials can easily be created under My Application for each of your applications, such as one for your web application and another for your mobile app.

Will an API v2 API key work for API v3?

No, API v3 Client Credentials are entirely different from the API key used in API v2.

Are all Eagle Eye devices supported in API v3?

Yes, all Eagle Eye accounts and devices are supported across both APIs. API v3 only extends the possibilities and does not restrict any existing functionality.

What is the future of API v2?

API v2 will continue to be supported with no current plans on deprecation. While existing integrations remain secure, starting new integrations with API v3 is encouraged due to its enhanced capabilities.

Which account types can benefit from API v3?

All account types can benefit from API v3, including end user and reseller accounts. Future updates will introduce even more possibilities for reseller accounts.

Which VMS editions can utilize API v3?

The API v3 supports all VMS editions, including Standard, Professional, and Enterprise. All features available in your VMS edition are available via the API v3.

Is integrating with API v3 free?

Yes, integration with API v3 is currently free of charge. You only need to create Client Credentials under your account.

How can I stay updated about new developments in API v3?

The developer portal Changelog is the best place to stay informed about updates to API v3, including improvements and critical updates.

What kind of support is available for developers integrating with API v3?

Eagle Eye offers comprehensive support for developers through detailed documentation and direct support channels via [email protected] to assist your integration process.

Cameras and devices

Where can I access the Open API/Swagger files for the APIs?

All Open API/Swagger files are available in the VMS-Developer-Portal GitHub repository.

Is there a Postman collection available for testing the API endpoints?

Yes, download a Postman collection from here: Postman Collections

What cameras are supported?

Eagle Eye Networks aims to support every camera available by having an open platform that can work with any camera. Digital cameras are typically connected via ONVIF profile S, but it is also possible to use RTSP directly. Eagle Eye Networks also supports analog (NTSC/PAL) and TVI camera through an encoder.

A complete and up-to-date list of supported cameras can be found here.

How can I request support for a new camera?

If an unknown camera is detected by an Eagle Eye Bridge/CMVR, the user has an option to request support for this camera. This is an automated process that can happen remotely. The camera needs to remain connected to a RTSP during the process.

Some firmware updates made by the camera manufacturers may have changes that are significant enough to require the camera to complete the support process again.

Is there any difference between types of cameraapi.c000.eagleeyenetworks.coms in the API?

There is no difference between camera types in the Eagle Eye API. Eagle Eye provides the same streams for each camera regardless of the camera type. In the case of analog cameras that do not send multiple streams, the conversion happens on the Eagle Eye bridge.

What about adding other devices (encoders, decoders, etc.)?

It is always possible to add the camera as a RTSP stream. It is possible to be added as two streams or as just a single stream. This opens the possibility to working with a wide range of devices.

Where can I find the old API?

The Eagle Eye Video API Platform supports multiple API versions: version 1, version 2 and version 3. This portal is is for API v3. For older APIs see: Legacy APIs

Where can I expand my general knowledge about Eagle Eye products?

If you are new to Eagle Eye Networks, we recommend becoming certified through Eagle Eye University. The Eagle Eye University training will help you better understand Eagle Eye hardware, products, and features. Eagle Eye University offers a variety of learning courses through on-demand or live sessions.

Feel free to explore and enroll in the courses that best suit your needs at https://www.een.com/university/.

Video streams and video formats

What is the supported format for streaming live video?

Eagle Eye Cloud VMS streams live video in various formats. The supported formats include the following:

FLV – Flash Video
HLS – HTTP Live Streaming
RTSP – Real Time Streaming Protocol
RTSP over TLS – RTSP encrypted using TLS
RTSP over HTTPs – RTSP tunneled via HTTPs
HTTP MultiPart – Raw video data via HTTP Multipart parts

The video is not transcoded or compressed, so it is effectively the same as the video direct from the camera. The available video streaming URLs can be obtained via the REST Feeds API.

What is the supported format for recorded video?

Recorded video can be requested in multiple formats and protocols. Depending on the protocol, the video is streamed or downloaded. The following formats are supported:

FLV – Flash Video
RTSP – Real Time Streaming Protocol
RTSP over TLS – RTSP encrypted using TLC
HTTP MultiPart – Raw video data via HTTP Multipart parts
MP4 – An on-the-fly generated MP4 file

MP4 is the recommended way to obtain video. The REST Media API provides a list of available recordings and the URLs to obtain the video. The MP4 clip can be altered in the request by changing the start and end times. This way a video clip can be generated with custom start and end times.

MP4 has the following benefits:

Custom MP4 clips can be generated on the fly with different start times and durations.
MP4 supports progressive download, meaning that it only downloads the relevant part of the video.
MP4 clips can be embedded in a web application without plugins using the HTML5 <video> element.

What date-time format is used in the API v3?

All dates for all API calls use the ISO 8601 date time format. The ISO 8601 timestamp format is a standardized format for representing date and time information. It uses the format "YYYY-MM-DDTHH:MM:SS.sss" where "T" is the separator between the date and time portions, and the ".sss" portion represents milliseconds.

API v3 standardizes the ISO format further to provide more consistent timekeeping. V3 enforces the +/-[hh]:[mm] timestamp pattern in both API requests and API responses. It will neither accept or return timestamps without the timezone offset. In addition, the timestamp must include the milliseconds portion. This ensures that all timestamps are consistent and accurate.

Here is an example of the ISO 8601 format: 2022-01-02T10:30:00.000+05:30 that represents 10:30 AM in the time zone that is 5 hours and 30 minutes ahead of UTC.

Note: API response timestamps are always based on UTC (+00:00) regardless of the timezone indicated in the request. For example, if the time zone in the request is 2023-09-13T11:13:35.791+02:00 the time zone in the response will be 2023-09-13T09:13:35.791+00:00.