Postman DOC
❖ Introduction
Postman is an Application Programming Interface (API) testing tool. API acts like an
interface between a couple of applications and establishes a connection between them.
Thus, an API is a collection of agreements, functions, and tools that an application can
provide to its users for successful communication with another application. We require
an API whenever we access an application like checking news over the phone, Facebook,
and so on.
Postman was designed in the year 2012 by software developer and entrepreneur
Abhinav Asthana to make API development and testing straightforward. It is a tool for
testing the software of an API. It can be used to design, document, verify, create, and
change APIs.
Postman has the feature of sending and observing the Hypertext Transfer Protocol
(HTTP) requests and responses. It has a graphical user interface (GUI) and can be used
in platforms like Linux, Windows and Mac. It can build multiple HTTP requests – POST,
PUT, GET, PATCH and translates them to code.
❖ Home
• Postman Home Dashboard -
The Postman home screen provides a central place to get started with API development and testing. Key
sections include:
• Set your team up for success – A guided onboarding to help teams collaborate effectively in
Postman.
• Get started
o Send an API request: Quickly create and test API requests (HTTP, GraphQL, gRPC,
WebSocket, [Link], MQTT).
o Import APIs and collections: Import existing APIs, collections, files, cURL commands, raw
text, or URLs for testing.
• Recently visited workspaces – Access previously used workspaces for quick navigation.
• Discover what you can do in Postman – Explore templates and learning resources to unlock more
Postman features.
• Sidebar navigation – Access Workspaces, Private API Network, Integrations, Reports, Insights, and
learning resources.
This page acts as a launchpad for setting up API requests, organizing workspaces, and collaborating with
teams.
❖Postman Collections
Postman Collections
• Collection = Group of API requests
Helps organize related requests (like login, signup, fetch data) in one place.
• Located in Left Sidebar → Collections Tab
You can create, view, and manage collections here.
• Features:
o Add folders & requests.
o Save authorization, headers, variables, and scripts at collection level.
o Write documentation.
• Usage:
o Run requests in sequence with Collection Runner.
o Share collections with team members.
o Export/import collections.
o Use in automation (Newman, CLI, CI/CD).
❖ Environments
🌍 What are Environments?
• An Environment is a set of variables (like baseURL, authToken, etc.) you can reuse across multiple
requests.
• Example: Instead of writing the full URL each time, you can store it as a variable → {{baseURL}}.
Key Parts in the Screenshot
1. Left Panel → Environments
o Lists available environments (e.g., Globals, DEV).
o You can create multiple (DEV, QA, PROD).
2. Variable Table (Middle)
o Columns: Variable | Type | Initial value | Current value
o Use it to define keys (like baseURL, token) and assign values.
3. Info Box (Bottom)
o Reminder that variables can store sensitive data securely (masking secrets).
Why It’s Useful
• Switch easily between different setups (DEV → QA → PROD).
• Avoid hardcoding values in requests.
❖ Flows
🔄 What are Flows?
• Postman Flows let you visually build workflows by connecting requests, data, and logic in a drag-
and-drop style interface.
Key Parts in the Screenshot
1. Left Sidebar → Flows
o Where all your created flows will be listed.
o Options to Create action or Create flow module.
2. Main Panel → Welcome to Flows
o Explains new features (like Actions in early access).
o Buttons for Begin tour and Learn more.
3. Quick Start Options
o Learn the basics → Guided intro to Flows.
o Browse templates → Use pre-built flow templates.
o Get support → Link to official docs.
❖ History in Postman
📜 What is History in Postman
• The History tab keeps a record of every request you’ve sent in Postman.
• It helps you quickly revisit, re-run, or save past requests without manually recreating them.
Key Parts in the Screenshot
1. Left Sidebar → History
o Shows requests grouped by date (e.g., July 29).
o Each entry displays:
▪ HTTP method (POST, GET, etc.)
▪ Request URL
2. Search bar
o Lets you filter/search requests from history.
3. Click on any entry
o Opens the request again in a new tab for re-execution or modification.
❖ Body In Postman
The Body tab in Postman is used to send data along with an API request. It allows you to include
information that the server needs to process your request.
• In POST, PUT, or PATCH requests, the body carries the data that you want to send to the server
(e.g., creating a new record, updating details).
• Postman supports multiple body formats:
o form-data – for file uploads and key-value data.
o x-www-form-urlencoded – sends data as key-value pairs in URL encoding.
o raw – allows sending plain text, JSON, XML, or other custom formats.
o binary – for sending files in binary form.
o GraphQL – for sending GraphQL queries.
In this screenshot, raw JSON is used, which is common for APIs because JSON is lightweight, structured,
and widely supported.
❖Headers tab in Postman
What Headers Do in Postman
• Headers are metadata for the request. They don’t carry the main data but describe how the
request (or response) should be processed.
• Common purposes:
1. Content Negotiation → Tell the server what format you’re sending (Content-Type) or what
format you expect back (Accept).
2. Authentication & Security → Carry tokens, API keys, session IDs.
3. Custom Instructions → Some APIs require special headers (e.g., tracking IDs, versioning).
4. Caching & Performance → Headers like Cache-Control manage how responses are stored
and reused.
• In Postman, the Headers tab is where you set these values so the API server can understand and
process your request properly.
❖Postman Workspace (Overall Screen Explained)
Postman Workspace (Overall)
1. Request Type & URL (Top bar)
o You choose HTTP method (POST, GET, etc.) and enter the API endpoint.
o Example here: POST [Link]
2. Tabs (Middle options)
o Params → Query parameters in URL
o Authorization → Authentication methods (API key, OAuth, etc.)
o Headers → Extra information/metadata (like Content-Type)
o Body → Main request data (here JSON payload)
o Scripts/Settings → Add pre-request or test scripts
3. Body (Center panel)
o Since it’s a POST request, the JSON payload (merchant details, IDs, etc.) is written here.
4. Response Section (Bottom)
o After clicking Send, the server’s response (status, body, headers) appears here.
5. Sidebar (Left)
o Navigation: Collections, Environments, Flows, History for organizing and reusing requests.
In short: This workspace is where you build, send, and test API requests.
• Top bar → Method & endpoint
• Tabs → Configure request
• Body → Send data
• Bottom → View response
