Enabling Local API Service on the Bridge

Enabling Local API Service on the Bridge

Info
The Bridge API Service feature is online availble on the premium plans. Dealers desiring to use the Bridge API feature will need to upgrade their CHeKT Dealer account to the Professional or Premium plan.
Alert
Before proceeding, you will want to have a CHeKT Bridge online (Firmware Version 3.5.0 or higher required) in your dealer portal with at least one camera connected.
  1. Registering a Bridge: Registering a CHeKT Bridge
  2. Connecting Cameras: Adding Cameras to a CHeKT Bridge
  3. Bridge API Documentation: http://external.chekt.click/swagger-ui/

Enabling Bridge API: 

Start by accessing the Bridge "settings" gear in the CHeKT Portal for the Bridge with the camera you want to create the alerts on, and accessing the network tab:




In the network tab locate the "Local API Service" option, which is disabled by default:




In the Local API Service tab, you will need to enable the API (1) and "Generate an API Key" (2)





Info
You can also define a custom port or limit access source IP's from the other modules in this menu

 Once "Generate a New API Key" is clicked, you will notice the unique API key is now shown in the field, and a "success" message is displayed at the bottom of the screen:



AlertWarning
The CHeKT Unit is now ready to receive an API call.