VideoProtects API Setup/Configuration
The instructions below will guide you in connecting to and configuring APIs related to VideoProtects. Visit the library/API Portal to get started: https://d170k8ngy6u21p.cloudfront.net/
Sign In/Register
In order to see, interact, and begin to configure individual API’s, an account must be created in the API Portal: https://d170k8ngy6u21p.cloudfront.net/. Sign In or Register for an account at the top of the page.
Enter your email and choose a password that meets the requirements.
You will receive a verification code in your email. Enter the code in the portal and click Confirm Account.
Once you’ve created and confirmed your account, you can subscribe to the APIs available.
Subscribing to APIs
Visiting the APIs page of the site will give you the option to “Subscribe” and/or Authorize.
Once you’ve created and confirmed your account, contact supportvideoprotects@jjkeller.com and include the following information:
- Email address used to create the account
- Name of the company for which you will need to access data
You will need to both Subscribe to the APIs and request that a company/fleet is assigned to your user name before the APIs will successfully return data.
Your API Key
You can see your API key by navigating to “My Dashboard”. This key can then be used to make calls within the portal and try out the APIs.
Fleet IDs
Some of the APIs involve using a FleetID to obtain data. If you need your FleetID, you can use the “Fleets” API to obtain this. Your FleetID will be presented once you click Try it out > Execute. (The ID should show above the name of the Fleet you’re assigned.) If you need access to additional fleets/locations, contact supportvideoprotects@jjkeller.com.
In the example below, this user has access to FleetID = 1, which represents a company called "VideoProtects Internal". The user would enter 1 as the FleetID parameter to return data for their company.
Available APIs
Below is a summary of the available APIs. Details about parameters and responses can be found in the API portal by clicking the arrow button beside the endpoint.
Cameras
For a given Fleet Id, returns the list of cameras associated with that fleet Id and information about the cameras as found on the Device Associations page, such as Last Heartbeat, Last Processed Event, and vehicle pairing information.
Fleets
Returns the list of fleets to which the user has access based on their API key. Fleet Id is used as a required parameter for other API endpoints.
Hello
This is a test endpoint for the Public API – if successful, it will return a ‘Hello World’ message.
Video Events
Returns a list of events based on Fleet Id and Start Date (with optional parameters for Video Event Type Id and End Date). Results include Event Id, Event Type, Event Date/Time, Event Status, Speed, GPS, Score, and Driver Name for each event.
Video Events – Types
For a given Fleet Id, returns the list of active video event types (Ids and names).
Video Events – Ids
For a given Fleet Id and Event Id, returns additional details about the event as found on the Event Details page, including the details returned by the Video Events endpoint along with any added comments, the date/time the event was sent to a driver, and the street address/city/state/zip code where the event occurred.
Requesting Additional APIs
If an API you’re looking for is not currently in the portal, please send additional suggestions to supportvideoprotects@jjkeller.com for review.