Skip to content
Postman API Testing Tips

What Tag Does Postman Use For Key

API Testing Blog

Defining Keys in Postman

Postman uses the concept of “variables” to store and manage dynamic values, often referred to as “keys” or “placeholders” in API testing. These variables can represent anything from API endpoints and headers to authentication tokens and data payloads.

How to Define Keys in Postman

  1. Create a Collection: Organize your API requests into a collection. This provides a structured way to manage your tests.
  2. Add a Variable: Navigate to the “Variables” tab within your collection. You can either create new variables or use existing variables from other collections.
  3. Name Your Variable: Assign a descriptive name to your variable. For example, baseUrl, apiKey, or userId.
  4. Set a Value: Specify the actual value for your variable. This can be a static value, a reference to an environment variable, or a dynamic value generated during your tests.

Example: Defining a Base URL

Let’s define a base URL for your API:

  1. Create a new collection named “My API”.
  2. Click the “Variables” tab within the collection.
  3. Click “Add Variable”.
  4. Name the variable “baseUrl”.
  5. Set the value to https://api.example.com.
    Now, instead of hard-coding the base URL in each request, you can use the {{baseUrl}} variable.

Using Keys in Requests

  1. Access Variables: In your API request, use the syntax {{variableName}} to reference a defined variable.

Example using the “baseUrl” variable:

GET {{baseUrl}}/users
  1. Dynamic Values: You can use “pre-request scripts” to calculate and assign values to your variables based on previous request responses or other data.

Example using a pre-request script to generate a timestamp:

// Pre-request script
pm.variables.set("timestamp", new Date().getTime());

Accessing Environment Variables

Postman allows you to define “environment variables,” which are global variables accessible across different collections. Environment variables are particularly useful for managing configurations for different environments (development, testing, production).

To access an environment variable, use the {{env.variableName}} syntax.

Example using an environment variable for API key:

  1. Create a new environment named “Production”.
  2. Add a variable named “apiKey” with the value YOUR_API_KEY.
  3. Select the “Production” environment.
  4. In your request, use {{env.apiKey}} to reference the API key.

Best Practices for Using Keys

  • Descriptive Naming: Choose meaningful names for your variables to improve readability and understanding.
  • Scope Management: Use local collection variables for request-specific data and environment variables for shared configurations.
  • Dynamic Values: Leverage pre-request scripts to dynamically generate and manage variable values based on your workflow.
  • Security: Properly secure your API keys and sensitive information.

Key (Variable) Management in Postman - Advanced Techniques

Working with Collections

  1. Sharing Variables: You can reuse variables across multiple API requests within a collection.
  2. Data Driven Testing: Use “collection runners” to iterate over a set of values for a variable, allowing you to perform multiple tests without manually changing request parameters.

Advanced Pre-Request Scripts

  1. Custom Logic: Implement complex logic in pre-request scripts to manipulate data, access external services, or perform conditional operations.
  2. Reusable Functions: Create custom functions within a collection to encapsulate common logic and enhance code reusability.
  3. Testing Assertions: Use pre-request scripts to set up conditions and perform assertions before executing the actual API request.

Utilizing Environments

  1. Environment Switching: Easily switch between different environments (development, testing, production) to adjust your API testing based on specific configurations.
  2. Global Variables: Use environment variables to store and manage sensitive information, eliminating the need to hardcode credentials directly into your tests.

Conclusion

Defining and effectively managing keys (variables) in Postman is a core skill for successful API testing. By leveraging collections, data-driven testing, environment variables, and pre-request scripting, you can streamline your workflows, create robust tests, and ensure the quality of your APIs.

API Testing Blog