API key authentication in Rest API - Step-by-Step Execution

Concept Flow - API key authentication

Client sends request with API key

↓

Server receives request

↓

Server checks if API key is present

↓

Server validates API key

↓

Is API key valid?

↓

Process request

↓

Send response to client

The client sends a request with an API key; the server checks if the key is present and valid before processing or rejecting the request.

Execution Sample

Rest API

GET /data HTTP/1.1
Host: api.example.com
API-Key: abc123

// Server checks API-Key header
// If valid, returns data
// Else returns error

A client sends a GET request with an API key; the server verifies the key and responds accordingly.

Execution Table

Step	Action	API Key Present?	API Key Valid?	Server Response
1	Receive request	Yes	Not checked yet	Waiting for validation
2	Check API key presence	Yes	Not checked yet	Proceed to validation
3	Validate API key	Yes	Yes	Process request and send data
4	Send response	Yes	Yes	200 OK with data
5	End	N/A	N/A	Request completed

💡 Request ends after sending response based on API key validity

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 3	Final
API Key Present	False	True	True	True	True
API Key Valid	False	False	False	True	True
Server Response	None	None	None	Data sent	Data sent

Key Moments - 3 Insights

What happens if the API key is missing in the request?

If the API key is missing, the server rejects the request immediately at Step 2, as shown in the flow where 'No' branch leads to rejection.

Why does the server check for API key presence before validating it?

The server first ensures the API key exists to avoid validating a missing key, which would cause errors. This is shown in Step 2 where presence is checked before validation.

What response does the server send if the API key is invalid?

If the API key is invalid, the server rejects the request with an error response instead of processing it, as indicated by the 'No' branch after validation in the flow.

Visual Quiz - 3 Questions

Look at the execution table, at which step does the server confirm the API key is valid?

A Step 2

B Step 3

C Step 4

D Step 1

💡 Hint

Check the 'API Key Valid?' column in the execution table to see when it changes to 'Yes'.

According to the variable tracker, what is the value of 'Server Response' after Step 3?

A None

B Error message

C Data sent

D Waiting

💡 Hint

Look at the 'Server Response' row in the variable tracker after Step 3.

If the API key was missing, how would the execution table change?

A API Key Present would be 'No' at Step 2 and server response would be rejection

B API Key Valid would be 'Yes' at Step 3

C Server would process the request anyway

D API Key Present would be 'Yes' at Step 1

💡 Hint

Refer to the concept flow where missing API key leads to immediate rejection.

Concept Snapshot

API key authentication requires clients to send a secret key with requests.
Server checks if the key is present and valid.
If valid, server processes the request.
If missing or invalid, server rejects with error.
This protects API access from unauthorized users.

Full Transcript

API key authentication works by the client sending a request with a special key called an API key. The server first checks if this key is included in the request. If the key is missing, the server rejects the request immediately. If the key is present, the server then checks if the key is valid. If the key is valid, the server processes the request and sends back the data. If the key is invalid, the server rejects the request with an error. This process ensures only authorized clients can use the API.

Practice

1. What is the main purpose of an API key in API key authentication?

easy

A. To store user passwords securely

B. To encrypt the data sent between client and server

C. To control and restrict access to the API

D. To speed up the API response time

Solution

1. Step 1: Understand the role of API keys

   API keys are used to identify and authorize clients accessing an API.

2. Step 2: Differentiate from other security methods

   API keys do not encrypt data or store passwords; they control access.

3. Final Answer:

   To control and restrict access to the API -> Option C

4. Quick Check:

   API key = Access control [OK]

Hint: API keys control who can use the API, not data encryption [OK]

Common Mistakes:

• Confusing API keys with encryption keys
• Thinking API keys store user passwords
• Assuming API keys improve speed

2. Which of the following is the correct way to send an API key in an HTTP request header?

easy

A. Key: YOUR_API_KEY

B. Api-Key: YOUR_API_KEY

C. Authorization: Bearer YOUR_API_KEY

D. X-API-KEY: YOUR_API_KEY

Solution

1. Step 1: Identify common header names for API keys

   Many APIs use the header 'X-API-KEY' to send the API key securely.

2. Step 2: Differentiate from other header formats

   'Authorization: Bearer' is for tokens, not API keys; 'Api-Key' and 'Key' are less standard.

3. Final Answer:

   X-API-KEY: YOUR_API_KEY -> Option D

4. Quick Check:

   Standard header = X-API-KEY [OK]

Hint: API keys usually go in 'X-API-KEY' header [OK]

Common Mistakes:

• Using 'Authorization: Bearer' for API keys
• Sending API key as 'Key' header
• Confusing API key with OAuth token

3. Consider this Python code snippet using the requests library to call an API with an API key:

import requests
headers = {"X-API-KEY": "12345"}
response = requests.get("https://api.example.com/data", headers=headers)
print(response.status_code)

What will this code print if the API key is valid and the request succeeds?

medium

A. 401

B. 200

C. 404

D. 500

Solution

1. Step 1: Understand HTTP status codes

   200 means success, 401 means unauthorized, 404 means not found, 500 means server error.

2. Step 2: Analyze the code behavior with valid API key

   With a valid API key, the server should authorize the request and respond with 200.

3. Final Answer:

   200 -> Option B

4. Quick Check:

   Valid key = 200 OK [OK]

Hint: Valid API key means HTTP 200 success code [OK]

Common Mistakes:

• Confusing 401 Unauthorized with success
• Assuming 404 means invalid key
• Thinking 500 is related to API key

4. You have this code snippet to send an API key in a URL parameter:

import requests
url = "https://api.example.com/data?api_key=12345"
response = requests.get(url)
print(response.status_code)

The server always returns 401 Unauthorized. What is the most likely problem?

medium

A. The API key value is incorrect

B. The URL is missing HTTPS

C. The API key should be sent in headers, not URL parameters

D. The requests library does not support URL parameters

Solution

1. Step 1: Check if sending API key in URL is allowed

   Many APIs accept API keys in URL parameters, so this is often valid.

2. Step 2: Consider the 401 Unauthorized response

   401 usually means invalid or missing credentials, so the key value is likely wrong.

3. Final Answer:

   The API key value is incorrect -> Option A

4. Quick Check:

   401 = Invalid credentials [OK]

Hint: 401 usually means wrong or missing API key value [OK]

Common Mistakes:

• Assuming URL parameters never work for API keys
• Ignoring that 401 means invalid credentials
• Thinking requests library can't send URL parameters

5. You want to secure your API by rotating API keys regularly. Which approach best ensures security while allowing clients to continue using the API without interruption?

hard

A. Generate a new key, distribute it, then disable the old key after a grace period

B. Generate a new key and immediately disable the old key

C. Keep using the same key indefinitely to avoid client issues

D. Send the API key in the URL to make it easier to update

Solution

1. Step 1: Understand key rotation best practices

   Rotating keys means replacing old keys with new ones to improve security.

2. Step 2: Ensure clients have time to update keys

   Disabling old keys immediately can break clients; a grace period avoids this.

3. Final Answer:

   Generate a new key, distribute it, then disable the old key after a grace period -> Option A

4. Quick Check:

   Grace period = smooth key rotation [OK]

Hint: Use grace period when rotating keys to avoid downtime [OK]

Common Mistakes:

• Disabling old key immediately causing client failures
• Never rotating keys risking security
• Sending keys in URL exposing them