[Deep Learning VCA Integration] How to use Postman for API Testing?

Question

How to use Postman for API Testing?

Answer

(1) Postman – API Testing Tool

Postman is a comprehensive API testing tool that simplifies creating, testing, and documenting APIs.

It provides an intuitive user interface that enables developers to design and test APIs and automate their testing processes easily.

Postman also supports collaboration among team members by allowing them to share and version control their API tests and collections.

(2) How do you test API using Postman?

Step 1. Sign up for a Postman Account

The first step is to create an account on Postman. You can create an account by downloading Postman on Windows or MacOS or using the Postman online.

To install Postman, go to the official website and click Download for Mac / Windows / Linux depending on your platform.

Official website: https://www.postman.com/downloads/

Step 2. Sign in to Postman

Step 3. Create a New Request

Once you have installed Postman, you can create a new request by clicking the "New" button in the top left corner of the Postman window. Select " HTTP" to create a new request.

Step 4. Try using Postman to execute an HTTP GET method

Refer to the VIVOTEK Deep Learning VCA Integration Guide and use the following command to retrieve the relevant parameter values for IntrusionDetection.

Step 5. Go to Camera Configuration > Network > Streaming protocols > HTTP and set the Authentication to basic.

Step 6. Go to Camera Configuration > Applications > Smart VCA and create the IntrusionDetection rule.

Step 7. In the Untitled Request > Authorization tab, select Basic Auth from the Auth Type dropdown list.

Step 8. In the Untitled Request > Body tab, select raw > JSON format with this body.

Step 9. Send the Request.

Once you have entered the request details, click the "Send" button in Postman to send the request to test the API.

Postman will display the response in the interface, including the response status, headers, and body.

Note: You must first create a Smart VCA (IntrusionDetection) rule to successfully retrieve the relevant information using the GET method.