API URLs
The Eagle Eye Networks Video API Platform uses multiple domains and Base URLs when making an API request. This guide explains which domain/URL should be used in each case.
Authentication URL
The Video API Platform uses a unique domain for authentication: https://auth.eagleeyenetworks.com
. With this domain you can log in, log out, or renew your access token.
When signing in, users might get redirected to a different domain. For Eagle Eye accounts this is https://id.eagleeyenetworks.com
. If the user configured Single Sign-On then the user might get redirected to a different domain.
Retrieving the Base URL
After authentication, an account-specific Base URL is available. All API requests should be made against this Base URL, unless otherwise stated in the API specification. The Base URL makes sure that you communicate directly with the Eagle Eye Video API Platform, ensuring the lowest latency.
- Retrieve the Base URL with the following request:
Headers HTTP GET: https://api.eagleeyenetworks.com/api/v3.0/clientSettings
Accept application/json
Authorization Bearer Y2xpZW50SWQ6Y2xpZW50U2VjcmV0
Response:
{
"httpsBaseUrl": {
"hostname": "api.c000.eagleeyenetworks.com",
"port": 443
}
}
Retrieving Media URLs
Retrieve video and audio for a device via the /media and /feeds API. Depending on your preferred protocol, you can retrieve video in RTSP, HLS, or MP4.
Important
Although the request to get the Base URL often returns the same value, do not hardcode it into any application. The Base URL is dynamic and might change.
Media URLs are also generated dynamically, and can only be cached for a maximum of two hours.
If you hardcode either the Base URL or the Media URL values, your integration will likely break unexpectedly.
Updated over 1 year ago