Skip to content
Postman API Testing Tips

How To Access Api Using Postman

API Testing Blog

Understanding APIs and Postman

APIs (Application Programming Interfaces) are the communication channels between different software applications. They allow applications to share data and functionalities. Postman is a powerful tool designed for API testing and development, offering a user-friendly interface for sending requests, analyzing responses, and managing APIs.

Getting Started with Postman

To begin, you’ll need to download and install Postman. It’s available for free at https://www.postman.com/. Once installed, you can start exploring its features.

Creating a New Request

  1. Open Postman: Launch the Postman application.
  2. New Request: On the Postman interface, click on the “New” button and select “Request”.
  3. Choose HTTP Method: Select the appropriate HTTP method for your API request (e.g., GET, POST, PUT, DELETE).
  4. Enter Request URL: Input the complete API endpoint URL in the address bar.

Making Your First API Request

Let’s take a simple example of fetching data from a public API:

Example: Accessing the Open Weather Map API

  1. API Endpoint: https://api.openweathermap.org/data/2.5/weather?q=London&appid=YOUR_API_KEY (Replace YOUR_API_KEY with your actual OpenWeatherMap API key).
  2. Method: GET (to retrieve data).
  3. Headers:
    • Content-Type: application/json
  4. Send Request: Click on the “Send” button.

Exploring the Response

Once you send a request, Postman will display the response from the API.

  • Response Status: Check the HTTP status code (e.g., 200 - OK, 404 - Not Found).
  • Response Body: Inspect the data returned by the API, usually in JSON or XML format.
  • Response Headers: Examine headers sent by the API, providing additional information.

Adding Authorization

Many APIs require authentication to access their resources. You can configure authorization in Postman:

  1. Authorization Tab: Select the “Authorization” tab in the request window.
  2. Type: Choose the appropriate authorization type (e.g., Basic Auth, API Key, OAuth 2.0).
  3. Configure Credentials: Provide the required credentials (username, password, API key, etc.).

Example: Basic Authentication

Let’s imagine an API that requires Basic Authentication:

  1. Username: <your_username>
  2. Password: <your_password>

In Postman, under the “Authorization” tab, select “Basic Auth” and input the username and password.

Sending Data with POST Requests

To send data to an API (e.g., create a new resource), use the POST method:

  1. Method: Select “POST”.
  2. Body Tab: Go to the “Body” tab.
  3. Select Data Type: Choose the data format for your request (e.g., JSON, form-data).
  4. Input Data: Enter the data you want to send in the body.

Example: Creating a To-Do Item

{
  "title": "Buy groceries",
  "completed": false
}

Testing APIs with Postman Collections

Postman collections are a powerful way to manage and organize API requests. They allow you to group multiple requests together and automate testing workflows.

Creating a Collection

  1. New Collection: Click on the “Collections” button on the left-hand side of the Postman interface.
  2. Create New Collection: Click on the “Create Collection” button.
  3. Name and Description: Provide a name and description for your collection.

Adding Requests to a Collection

  1. Add Request: Click on the “Request” section within your collection.
  2. Add Existing Request: Drag and drop existing requests from your workspace into the collection.
  3. New Request: Create new requests directly within the collection.

Running Collections and Automated Tests

Postman allows you to run your collections automatically and define tests to verify API behavior:

Running a Collection

  1. Collection Runner: Select the “Runner” tab in Postman.
  2. Choose Collection: Select the collection you wish to run.
  3. Run: Click on the “Run” button.

Writing Tests

  1. Tests Tab: Go to the “Tests” tab in your request.
  2. Code Editor: Use the code editor to write test scripts based on the response data.
  3. Assertions: Use assertion functions (e.g., pm.test(), pm.expect()) to verify expected outcomes.

Conclusion

Postman empowers you to work with APIs effectively, from accessing data to testing and managing your API workflow. With its intuitive interface and powerful features, Postman is an essential tool for anyone involved in API development and testing.

API Testing Blog