Postman is a very popular tool used for API testing. Here are the simple steps to follow while testing your API using Postman:
Importing custom APIs
Log into your Beagle Security account
From the home dashboard, click Application
Select the application from the list
Click on the API Configuration button
From the above screen, click on the Integrate button to integrate
Similarly click on the configure button from the configuration box, if you need to configure your API
After clicking on the Integrate button from the integration box, you can see a pop-up screen namely, Postman Integration
From the above pop-up screen enter your Postman Key
Paste the API Key from the Postman tool
Click on the Connect button to continue
How to get a Postman Key?
To make requests to the Postman API, you must have a valid Postman API key.
Open you API Keys page >> Settings>> click API Keys
If you do not have one you will need to create one >> Select Generate API Key
Enter a name for you Key >> Select Generate API Key
Copy the API Key, once the API Keys are generated you can manage them in your workspace
Back to Beagle Security page
After clicking on the Connect button, you will see the Workspace screen
Select your Workspace from the dropdown list given
Select your Collection from the dropdown box
Finally, select the Environment which is optional
Click Next to Continue
Different APIs and the key and value of the selected Environment is displayed on the screen
Click on the Next button to continue
In the Run Scripts page, select any queries >> click on the Run button
The queries in progress will be displayed on the left side of the screen
Click on Next button to continue
You can initiate your test by clicking on the Start Test button
Click on the Finish button
Environment
Environments store variables in the form of key-value pairs, essentially serving as contexts for API requests.
Note: This page is a ‘view only page’. Every configuration done in the Postman tool will be integrated to this page.
Authorization
As Global Authorization is enabled, the related data will be reflected here. This method will be used for every request in the collection. This can be overridden by specifying one in the request.
Note: This page is a ‘view only page’. If unmatched configuration is selected, an error message will pop on the top right of the dashboard.
Collections
Collection from Postman groups are similar individual API requests. Users can share the collection with headers, body, URL parameters, authorization configuration etc.
Select Collections from the left side menu bar
Click on any APIs to view the details
Click on the send button
You can check Parameters, Authorization, Headers, Body, Pre- Request Script and Automation from the screen
Parameters
Authorization
Headers
Body
Pre-Requisite Script
Authorization
Run Scripts
Here you can build integration test suites, transfer data between API requests, and establish workflows that replicate your real-world API scenarios.
Select Run Scripts from the left side menu bar
Click on the Scripts to run >> click the Run button
