API key authentication in Postman - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is API key authentication?

API key authentication is a method where a unique key is sent with API requests to identify and authorize the client.

beginner

Where can you include an API key in a request?

You can include an API key in the request header, URL query parameters, or sometimes in the request body depending on the API design.

beginner

Why should API keys be kept secret?

API keys grant access to resources. If exposed, unauthorized users can misuse the API, leading to security risks and data breaches.

beginner

How do you add an API key in Postman for testing?

In Postman, you can add an API key by going to the 'Headers' tab and adding a key-value pair, or use the 'Authorization' tab with the API Key type to set the key and its location.

beginner

What happens if you send a request without a required API key?

The server usually responds with an error like 401 Unauthorized or 403 Forbidden, indicating that authentication failed or access is denied.

What is the main purpose of an API key?

A To speed up the API

B To identify and authorize the client

C To encrypt the data

D To style the API response

API keys are used to identify and authorize clients making API requests.

Where can you NOT typically send an API key?

A Request header

B URL query parameters

C Request body

D Response body

API keys are sent with requests, not in the response body.

In Postman, which tab is commonly used to add an API key?

A Tests

B Body

C Headers

D Cookies

API keys are often added in the Headers tab as key-value pairs.

What HTTP status code indicates missing or invalid API key?

A 401 Unauthorized

B 200 OK

C 302 Found

D 500 Internal Server Error

401 Unauthorized means authentication failed, often due to missing or invalid API key.

Why should API keys never be shared publicly?

A They can be used by others to access your API

B They expire immediately

C They can slow down the API

D They are only for decoration

Sharing API keys publicly risks unauthorized access to your API.

Explain how API key authentication works and how you would test it using Postman.

Think about where the key goes and what happens if it is missing.

Describe best practices for handling API keys securely.

Consider how to protect keys from misuse.

Practice

1. What is the main purpose of using an API key in Postman when testing an API?

easy

A. To authenticate and authorize access to the API

B. To format the API response data

C. To change the API endpoint URL

D. To speed up the API response time

Solution

1. Step 1: Understand API key role

   An API key is used to identify and authorize the client making the request.

2. Step 2: Identify purpose in Postman

   In Postman, the API key is added to authenticate requests so the server knows who is calling.

3. Final Answer:

   To authenticate and authorize access to the API -> Option A

4. Quick Check:

   API key = Authentication [OK]

Hint: API key controls access, not data format or speed [OK]

Common Mistakes:

• Confusing API key with response formatting
• Thinking API key changes URL
• Assuming API key improves speed

2. Which of the following is the correct way to add an API key in Postman headers?

easy

A. Key: Accept, Value: application/xml

B. Key: api_key, Value: <API_KEY>

C. Key: Content-Type, Value: application/json

D. Key: Authorization, Value: Bearer <API_KEY>

Solution

1. Step 1: Identify standard header for API key

   Many APIs use the Authorization header with a Bearer token format for API keys.

2. Step 2: Check other options

   api_key is not a standard header key; Content-Type and Accept relate to data format, not authentication.

3. Final Answer:

   Key: Authorization, Value: Bearer <API_KEY> -> Option D

4. Quick Check:

   Authorization header = API key location [OK]

Hint: Use Authorization: Bearer <API_KEY> for API key in headers [OK]

Common Mistakes:

• Using Content-Type or Accept headers for API key
• Using non-standard header names like api_key
• Omitting Bearer prefix when required

3. Consider this Postman request setup:

GET https://api.example.com/data?api_key=12345

What will happen if the API key is missing from the query parameters?

medium

A. The API will return a 404 Not Found error

B. The API will return a 401 Unauthorized error

C. The API will return data without restrictions

D. The API will return a 500 Internal Server Error

Solution

1. Step 1: Understand API key role in authentication

   API keys are used to verify the client. Missing keys usually cause authentication failure.

2. Step 2: Identify typical server response

   When authentication fails, servers commonly respond with 401 Unauthorized status.

3. Final Answer:

   The API will return a 401 Unauthorized error -> Option B

4. Quick Check:

   Missing API key = 401 Unauthorized [OK]

Hint: Missing API key usually causes 401 Unauthorized error [OK]

Common Mistakes:

• Assuming API returns data without key
• Confusing 404 Not Found with authentication errors
• Thinking server crashes with missing key

4. You set the API key in Postman as a header: api_key: 12345. The API still returns 401 Unauthorized. What is the most likely issue?

medium

A. The API key value is too short

B. The API endpoint URL is wrong

C. The API key header name is incorrect; it should be Authorization

D. Postman does not support headers for API keys

Solution

1. Step 1: Check header naming conventions

   Most APIs expect the API key in the Authorization header, not api_key.

2. Step 2: Verify Postman supports headers

   Postman fully supports headers, so the issue is likely the header name, not Postman itself.

3. Final Answer:

   The API key header name is incorrect; it should be Authorization -> Option C

4. Quick Check:

   Correct header name = Authorization [OK]

Hint: Use Authorization header, not api_key, for API keys [OK]

Common Mistakes:

• Using wrong header name
• Blaming Postman for header issues
• Ignoring API key format requirements

5. You want to securely test an API in Postman using an API key. Which combination of steps ensures best security practice?

hard

A. Add the API key in headers, use HTTPS, and keep the key private

B. Add the API key in URL query parameters and share the collection publicly

C. Use HTTP protocol and add API key in request body

D. Store the API key in environment variables and disable SSL verification

Solution

1. Step 1: Use HTTPS for secure communication

   HTTPS encrypts data, protecting the API key from being intercepted.

2. Step 2: Add API key in headers and keep it private

   Headers are safer than URL parameters; keeping the key private prevents leaks.

3. Final Answer:

   Add the API key in headers, use HTTPS, and keep the key private -> Option A

4. Quick Check:

   HTTPS + headers + privacy = secure API key use [OK]

Hint: Use HTTPS and headers; never expose API key publicly [OK]

Common Mistakes:

• Putting API key in URL query parameters publicly
• Using HTTP instead of HTTPS
• Disabling SSL verification in Postman