Skip to content

How to test API Integration with third-party apps

The purpose of this test is to verify that the Broox products, specifically the Vision Node and the Controller, are functioning correctly in terms of communication through the API. The goal is to ensure that the Vision Node can analyze a video, detect relevant information (such as the number of people), and send this data accurately to the cloud through the API.

The steps outlined below will guide developers in configuring the required files, running the tests, and verifying the communication of data between the Broox Vision Node and the Broox Test App.

This test is essential to validate that the integration with the API is working correctly, allowing the Vision Node to receive accurate data about the video content and send it for further analysis.

Key Steps of the Test:

  1. Environment Setup: Configuring the necessary license, calibration, and configuration files to ensure the Vision Node operates correctly.

  2. Running the Test: Loading the test files and executing the Vision Node with a predefined video, while monitoring the communication in real-time using the Broox Test App.

  3. Results Verification: Checking that the data sent by the Vision Node (such as the number of people detected) matches the values defined in the groundtruth.txt file, ensuring API accuracy.

This verification process is crucial to ensure that Broox products are correctly configured and capable of sending accurate data through the API for further analysis and processing.

Environment Setup

Requiered Software

  1. Controller
  2. Vision node
  3. Broox Test App - Support

Required Files:

The necessary files are as follows:

  1. API-TEST.license
  2. Video.mp4
  3. groundtruth.txt
  4. calibration.txt
  5. visionnode.ini

Download the files and store them wherever you consider better.

  • File Descriptions:

Licensce

  • The license file configures the Controller and helps quickly locate output data.

It must be loaded on the Controller with the 'Read .license file' button

Video

  • The file that the Vision Node will analyze.

groundtruth.txt

  • This file contains the actual data for the video. It specifies how many people the Vision Node should detect and communicate.

calibration.txt

  • This file contains the camera calibration data (intrinsic and extrinsic) for the video. It is essential for the Vision Node to function properly.

  • This file must be copied to the following path:

    C:\Users\\AppData\Local\Broox Vision Node\Broox Vision Node

visionnode.ini

  • This file contains all the configuration settings for the Vision Node to run the test efficiently.

  • It must be copied to the following path:

    C:\Users\\AppData\Local\Broox Vision Node\Broox Vision Node

Running the test

Condigurations

Step 1: Configuring the Controller

  1. Open the Controller.

  2. Load the .license file using the Read .license file button.

  3. Run the Controller.

Step 2: Configuring the Vision Node

  1. Copy the calibration.txt and visionnode.ini files to the following path:

    C:\Users\\AppData\Local\Broox Vision Node\Broox Vision Node

Step 3: Configuring the Broox Test App

  1. Open the Config tab in the Analytics section and fill in the following fields:

  2. Host: broox-studio-staging

  3. Account ID: -NxvZuBh8xwrqF-yAbRh
  4. Account API Key: ef9a14a0-df71-4416-a5bc-5a95c4b8d17c

Note: The data provided here is an example. To configure the test with your own instance, follow these steps:

Obtaining the Host:

  1. The Host field is broox-studio-analytics

Obtaining the Account ID and API Key:

  1. The Account ID and Account API Key are specific to your account and are used for authentication when interacting with Broox's services. To find them:

  2. Navigate to the Account list on your Broox studio instance.

  3. Locate the account you want to use for this test, then click the pencil and paper icon (edit icon) next to it to open the account settings.

  4. In the opened window, look for the fields labeled ID and API KEY.

  5. Copy the value from the ID field to populate the Account ID field.

  6. Copy the value from the API KEY field to populate the Account API Key field.

This will ensure that you are using the correct credentials for your account when configuring the test.

  1. In the Config tab, under the Stage section, fill in the MQTT Address field with:

    mqtt://127.0.0.1

  2. Save the configuration by clicking the Save button.
  3. Go to the Stage tab and select MQTT to view any messages.

Step 4: Test Execution 1. Open Command Prompt: - Press the Windows key + R. - Type cmd* and press Enter**.

  1. Change directory to the Vision Node’s installation folder: > cd C:\Program Files (x86)\Broox Vision Node

  2. Run the test with the following command:

    Type: BrooxVisionNode.exe -d -i -f -P traffic-measure.yml -C

  3. During the test, you can monitor the messages the Vision Node is sending to the cloud in the Broox Test App.

Results Verification

  1. In the Broox Test App, go to the Analytics section.

  2. Select the getTotalAudience method.

  3. Apply the following filters:

    • From = 'Today'

    • To = 'Today'

  4. Click on fetch Button.

  5. Verify that the count displayed in the Broox Test App matches the count from the groundtruth.txt file.

Depending on the test run, the count may be off by 1 (either up or down) compared to the groundtruth.txt file.