- Quick Start Guide with Examples on Github Jump right in and start using our API in under five minutes. Learn how to get your OAuth token, curl for camera data, and use our ruby gem to get data into your Rails project.
- API Documentation Take a look at our docs on the interactive API tool Swagger. If you already have your Oauth token from the quick start guide, you can see real data in this tool without any programming.
We use Oauth2, an industry standard, for authorization. With OAuth2, our API supports authorization for web applications, desktop applications, mobile phones, and devices.
Because we use OAuth 2.0 exclusively, all API requests must be done over SSL. This allows us to do away with complex and frustrating request signatures that were part of the OAuth 1.0a spec.
The Sensr.net API takes advantage of all four HTTP verbs: GET, POST, PUT, and DELETE to interact with entities exposed through the API. This allows us to simplify endpoints and makes the API more self-describing. The API also returns HTTP status codes that best describe the response from the server. Where possible, we try to return descriptive error messages to allow for a better understanding of what actually went wrong. The API is RESTful and self documented.
The current version of the API is Version 3, as reflected by the url prefix /v3.
Currently, the only supported response content-type is application/json.
Terms and Conditions
Before you get started, make sure to take a look at our API Terms and Conditions
Base Resource API URL
The Sensr.net API provides an entry that exposes all the resources available to the developer. For the current version of the API (v3), the base resource URL is:
Getting the base resource URL (with wget, a browser, or curl), yields the following response:
Let's take a quick look at the response. On line 4, it tells you the current version of the API "v3". Then, on line 5, you get and array of supported resources "apis". So now you know that the following resources are available: users, cameras, clips, plans, devices. From there, you can look at the interface for the user's resource by loading the entry point: https://api.sensr.net/u/v3/users. Same goes for all the resources that are exposed by the API and listed there.
App & Web Developers
Share live views and cameras across the web, learn how to use Sensr.net widgets to share your camera.
Integrate your mobile application with Sensr.net or write a script to download images from a camera and generate a timelapse movie, learn how you can leverage our REST API and the ruby binding (sensr gem).
Integrate your alarm service with our back-end, build a sensr enabled cloud ip camera. To learn more about our Partner API and our camera SDK, subscribe to our partner mailing list and will send you all the information.
Feel free to email us if you have any questions about our APIs.
You can use the Sensr.net API for free, as long as you accept the Sensr.net API Terms and Conditions.