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. 


    • Related Articles

    • Enabling and Understanding Site Service Plans

      Enabling and Understanding Site Service Plans Understanding Service Plans The Following Chart and Descriptions of services can be found in the billing section, of the gear settings, of your dealer portal *1 If yes on Prorated, dealers will be charged ...

    • Enabling The Talk Down Service Plan

      Watch this video for instructions for enabling the Bridge Talk Down service. This service allows the installation company to use a local speaker system for audio talk down from the CHeKT Monitoring Portal Steps to Enable TalkDown (For those who would ...

    • Overview of CHeKT API Integrations

      There are Two main methods of utilizing API calls to interface with the CHeKT solution. Our Local API method is designed to create alarms on a CHeKT Bridge channel from a local network request with a valid key; the CHeKT Cloud APIs are designed to ...

    • CHeKT Bridge Local Web Interface (Admin Tool)

      The CHeKT Bridge can be accessed via the web browser from a device on the same Local Area Connection. This is not normally required for basic set up, but offers another method to interface with the unit and can allow for configuration when the device ...

    • Integrating Camect AI Detection w\ CHeKT

      The Camect Smart Hub can create video alarms in the CHeKT Portal by triggering the Bridge with an API. The associated Camect Video Event will also be visible in the monitoring portal. Before proceeding, you will want to have a CHeKT Bridge online ...