Evercam.io API

The evercam REST API supports multiple different authentication mechanisms to ensure that whatever environment you find yourself in, we’ve got you covered. This section of the documentation outlines the various methods available.

Basic

To make it as easy as possible for developers to quickly test and learn the various resource actions available we’ve enabled HTTP basic authentication using your username (or email) and password. The following cURL command illustrates this authentication method.

curl -X GET https://api.evercam.io/v1/... \
-u {username}

Session

As evercam utilises cookies to maintain a users session once they have been logged in, any ajax requests originating from the same user agent can be told to include the apprioriate credentials. This can be achieved in jQuery in the following way:

jQuery.ajax({
  url: 'https://api.evercam.io/v1/...',
  xhrFields: {
    withCredentials: true
  },
  statusCode: {
    200: {
      ...
    },
    ...
  },
  ...
});

OAuth 2.0

Implicit Grant

Our implementation supports the implicit grant type which can be used to obtain access tokens. It is optimised and secured for clients with a predetermined set of redirect uris. Typically this means a browser using javascript. It is a redirection-based flow which, when successfully authorized, results in the browser being directed back to the client application with an access token appended to the fragment portion of the redirect uri. The process starts with the client (you) redirecting the user (their browser) to our authorization endpoint with the following querystring parameters. Values surrounded with curly braces { } are required, those surrounded by square brackets [ ] are optional.

https://www.evercam.io/oauth2/authorize...

?response_type=token
&client_id={your evercam client id}
&scope={the access scopes you wish to use}
&redirect_uri=[one of your registered callback uris] // optional
&state=[a value you choose to help prevent CSRF] // optional

If the user has previously granted your application access to all the resources requested in the scope parameters, or if the user chooses to now authorize those scopes, evercam will generate a new access token and redirect the user back to the either the redirect_uri parameter you provided or to the default callback uri associated with your client account when you registered. The access token and its duration will be appended as part of the uri fragment as follows:

https://{redirect_uri}#access_token=410d79341e45c915&token_type=bearer&expires_in=3600

If the user declines your authorization request or if your request is malformed or invalid then the user will be redirected back to the {redirect_uri} (or default callback uri) with an error status and message as follows:

https://{redirect_uri}#error=access_denied&error_description=some+error+message&state={your state}

Should the client_id parameter be invalid or the redirect_uri parameter not match one of the values you have registered with your account then the user will be shown an error on the evercam site.

Evercam.js

Evercam.js allows you to easily access all evercam.io APIs and also works as jQuery plugin which can easily show image from any evercam-enabled camera on a website. jQuery is dependency and it has to be included before evercam.js.

Including Evercam.js

Edit your HTML page and put following two lines inside head tag

<script src="http://ajax.googleapis.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
<script src='http://cdn.evercam.io/js/v1/evercam.js'></script>
So it will look like this:
<!DOCTYPE html>
<html>
<head>
  <title></title>
  <script src="http://ajax.googleapis.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
  <script src='http://cdn.evercam.io/js/v1/evercam.js'></script>
</head>
<body>

</body>
</html>

Showing camera snapshots

Via attributes

Simplest way to show image from camera on your website is to just add img tag with evercam specific attributes. Evercam.js will automatically load camera image into img tag with ‘evercam’ attribute set to stream name and refresh it every X seconds times 1000 (set in ‘refresh’ attribute). Typical camera image resolution is 640x480 pixels but you can adjust it to your needs using width and height parameters. Following line of code will get new snapshot from camera every 5 seconds and display it as 320x240 pixels image:

<img evercam='dublin-rememberance-floor2' width="320" height="240" refresh='5000' />
Following html page will display camera image on full screen and update it every 2 seconds:
<!DOCTYPE html>
<html>
<head>
<title></title>
  <script src="http://ajax.googleapis.com/ajax/libs/jquery/2.0.3/jquery.min.js"></script>
  <script src='http://cdn.evercam.io/js/v1/evercam.js'></script>
</head>
<body>
  <img evercam='dublin-rememberance-floor2' width="100%" height="100%" refresh='2000' />
</body>
</html>

Via JavaScript

Load camera image into jQuery selector by calling evercam method with ‘snapshot’ as first argument and options dictionary as second.

$(img).evercam('snapshot', {
  name: name,
  refresh: refreshRate
});

Following code will get new snapshot from camera every 5 seconds and display it as 320x240 pixels image:

$(img).evercam('snapshot', {
  name: 'dublin-rememberance-floor2',
  refresh: 5000
}).width(320).height(240);