Skip to content
Postman API Testing Tips

How To Use Aws Api Key In Postman

API Testing Blog

How to Use AWS API Keys in Postman for API Testing

Postman is a powerful tool for API testing, and AWS API Keys are essential for accessing and interacting with AWS services. This guide will walk you through how to use AWS API Keys within Postman to perform your API testing.

Getting Your AWS API Key

Before you can start using your AWS API key in Postman, you’ll need to obtain it. Here’s how:

  1. Create an IAM User: In the AWS console, navigate to IAM (Identity and Access Management) and create a new user.
  2. Assign Permissions: For your specific needs, you can assign permissions by attaching existing policies or creating custom policies. Ensure you grant the necessary permissions to access the AWS services you plan to test.
  3. Generate Access Keys: Once the user is created, click on “Security Credentials” in the user’s details page. Generate an Access Key ID and Secret Access Key. Important: Store these credentials securely as they provide complete access to your AWS account.
  4. Store Credentials Securely: For testing and development purposes, the simplest way to store your credentials is using a separate file or environment variables. Never hardcode them directly into your scripts or Postman collections.

How to Use AWS Access Keys in Postman:

Now that you have your AWS access keys, let’s integrate them into Postman for testing:

1. Managing Credentials Using Environment Variables:

Environment variables in Postman offer a robust and secure way to manage your credentials:

  1. Create Environment: Go to “Environments” in Postman, click “Add” to create a new environment, and give it a descriptive name (e.g., “AWS Test”).
  2. Add Variables: Create two variables in your environment:
    • AWS_ACCESS_KEY_ID: Store your Access Key ID here.
    • AWS_SECRET_ACCESS_KEY: Store your Secret Access Key here.
  3. Select Environment: Before making your requests, make sure your environment is chosen in the “Environment” dropdown in the Postman UI.

Example:

{
  "id": "AWS Test",
  "name": "AWS Test",
  "values": [
    {
      "key": "AWS_ACCESS_KEY_ID",
      "value": "YOUR_ACCESS_KEY_ID",
      "type": "text",
      "enabled": true
    },
    {
      "key": "AWS_SECRET_ACCESS_KEY",
      "value": "YOUR_SECRET_ACCESS_KEY",
      "type": "text",
      "enabled": true
    }
  ]
}

2. Authorization in Postman:

To authenticate your API requests using your AWS access keys, Postman offers different authorization methods:

a. API Key Authorization:

This is useful if your AWS service uses API keys (not access keys):

  1. Select Authorization: Open your request in Postman and click on the “Authorization” tab.
  2. Choose “API Key”: Select “API Key” from the dropdown.
  3. Configure Key: In the “Key” field, enter the name of the header that your API service expects (e.g., "X-Api-Key").
  4. Set Value: In the “Value” field, paste your AWS API Key.

Example:

{
  "type": "apiKey",
  "key": "X-Api-Key",
  "value": "YOUR_API_KEY"
}

b. AWS Signature Version 4:

If your service requires more complex authentication like AWS Signature Version 4, follow these steps:

  1. Choose “AWS Signature Version 4”: Select “AWS Signature Version 4” from the “Authorization” tab dropdown.
  2. Configure Credentials:
    • Access Key ID: Set this to the variable you created ({{AWS_ACCESS_KEY_ID}}).
    • Secret Access Key: Set this to the variable ({{AWS_SECRET_ACCESS_KEY}}).
    • Region: Specify the AWS region your service is deployed in (e.g., “us-east-1”).
    • Service: Input the name of the AWS service you’re targeting (e.g., “s3”).

Example:

{
  "type": "awsSigv4",
  "accessKeyId": "{{AWS_ACCESS_KEY_ID}}",
  "secretAccessKey": "{{AWS_SECRET_ACCESS_KEY}}",
  "region": "us-east-1",
  "service": "s3"
}

How to Test AWS APIs in Postman:

Now, let’s illustrate how to test a sample AWS API using Postman with the proper configuration:

Example: Using AWS S3:

  1. Choose the Right Method: Select the appropriate HTTP method (GET, POST, PUT, etc.) based on the S3 API action you want to perform.
  2. Set Endpoint: Use the correct S3 endpoint URL: https://s3.[region].amazonaws.com/[bucket-name] (replace placeholders with your specific values).
  3. Add Headers: For S3, you usually need to set the Content-Type header in your request. If your request requires more headers, refer to the specific S3 API documentation.
  4. Body (if needed): If your S3 operation requires sending data in the request body, construct the appropriate JSON or XML payload and set it in the “Body” tab.
  5. Send the Request: When ready, click “Send” to execute your request.

Example S3 GET Request (List objects in a bucket):

  • URL: https://s3.us-east-1.amazonaws.com/YOUR_BUCKET_NAME/
  • Method: GET
  • Authorization: AWS Signature version 4 (configured as explained above).
  • Headers: 
    {
     "Content-Type": "application/json"
    }

Important Considerations:

  • Security: Protect your AWS Access Keys from unauthorized access. Never hardcode them in your Postman collections, and use environment variables or separate secure storage for development and testing.
  • Permissions: Make sure the IAM user you created has the necessary permissions to perform the actions you need to test with the AWS service.
  • API Documentation: For complex interactions, refer to the AWS service API documentation for specific requirements, headers, and request body structures.

Conclusion:

By carefully integrating your AWS API Keys into Postman, you can leverage the tool’s capabilities to test your AWS services thoroughly. This approach allows for robust testing and verification of your AWS resources and APIs.

API Testing Blog