API key authentication concept in Flask

Introduction

API key authentication helps protect your app by checking if users have a secret key before they can use your service.

When you want to control who can access your web API.

When you need a simple way to identify and limit users.

When building public APIs that require basic security.

When you want to track usage by different clients.

When you want to block unauthorized access easily.

Syntax

Flask

from flask import Flask, request, jsonify

app = Flask(__name__)

API_KEY = 'your-secret-api-key'

@app.route('/data')
def get_data():
    key = request.headers.get('x-api-key')
    if key == API_KEY:
        return jsonify({'message': 'Access granted', 'data': [1, 2, 3]})
    else:
        return jsonify({'error': 'Unauthorized'}), 401

The API key is usually sent in the request headers for security.

Check the key on every request to protect your endpoints.

Examples

Basic check of API key from request headers.

Flask

key = request.headers.get('x-api-key')
if key == API_KEY:
    # allow access
else:
    # deny access

API key passed as a URL query parameter (less secure).

Flask

@app.route('/info')
def info():
    key = request.args.get('api_key')
    if key == API_KEY:
        return 'Info data'
    return 'Unauthorized', 401

Sample Program

This Flask app has one route that checks for a correct API key in the headers. If the key matches, it returns secret data. Otherwise, it returns an error.

Flask

from flask import Flask, request, jsonify

app = Flask(__name__)

API_KEY = '12345abcde'

@app.route('/secret-data')
def secret_data():
    api_key = request.headers.get('x-api-key')
    if api_key == API_KEY:
        return jsonify({'message': 'Welcome! Here is your secret data.', 'data': [10, 20, 30]})
    else:
        return jsonify({'error': 'Unauthorized access'}), 401

if __name__ == '__main__':
    app.run(debug=True)

Important Notes

Never expose your API key in public code or client-side apps.

Use HTTPS to keep the API key safe during transmission.

Consider rotating keys regularly for better security.

Summary

API key authentication is a simple way to protect your API.

Clients send a secret key with each request to prove they are allowed.

Always check the key on the server before giving access.

Practice

1. What is the main purpose of using an API key in Flask applications?

easy

A. To style the API output

B. To verify that the client is authorized to access the API

C. To speed up the API response time

D. To store user passwords securely

Solution

1. Step 1: Understand API key role

   An API key is a secret token sent by the client to prove identity.

2. Step 2: Identify purpose in Flask

   The server checks this key to allow or deny access to API resources.

3. Final Answer:

   To verify that the client is authorized to access the API -> Option B

4. Quick Check:

   API key = Authorization [OK]

Hint: API keys prove client identity to server [OK]

Common Mistakes:

• Thinking API keys speed up responses
• Confusing API keys with styling tools
• Using API keys to store passwords

2. Which of the following is the correct way to retrieve an API key from request headers in Flask?

easy

A. api_key = request.cookies.get('X-API-KEY')

B. api_key = request.args['X-API-KEY']

C. api_key = request.form['X-API-KEY']

D. api_key = request.headers.get('X-API-KEY')

Solution

1. Step 1: Identify where API keys are usually sent

   API keys are commonly sent in HTTP headers for security.

2. Step 2: Use Flask syntax to get header value

   Use request.headers.get('Header-Name') to safely retrieve header values.

3. Final Answer:

   api_key = request.headers.get('X-API-KEY') -> Option D

4. Quick Check:

   Headers use request.headers.get() [OK]

Hint: Use request.headers.get() for header values [OK]

Common Mistakes:

• Using request.args for headers
• Trying to get API key from form data
• Looking for API key in cookies

3. Given this Flask code snippet, what will be the response if the client sends a request with header X-API-KEY: wrongkey?

from flask import Flask, request, jsonify
app = Flask(__name__)

VALID_API_KEY = 'secret123'

@app.route('/data')
def data():
    api_key = request.headers.get('X-API-KEY')
    if api_key == VALID_API_KEY:
        return jsonify({'message': 'Access granted'})
    else:
        return jsonify({'error': 'Unauthorized'}), 401

medium

A. {"error": "Unauthorized"}

B. {"message": "Access granted"}

C. 500 Internal Server Error

D. Empty response with status 200

Solution

1. Step 1: Check API key comparison

   The code compares the header key to 'secret123'. 'wrongkey' does not match.

2. Step 2: Determine response for wrong key

   Since keys differ, the else block returns a JSON error with status 401.

3. Final Answer:

   {"error": "Unauthorized"} -> Option A

4. Quick Check:

   Wrong key = Unauthorized error [OK]

Hint: Wrong key triggers 401 Unauthorized JSON error [OK]

Common Mistakes:

• Assuming any key grants access
• Expecting 500 error for wrong key
• Thinking response is empty

4. Identify the error in this Flask API key check code:

from flask import Flask, request
app = Flask(__name__)

VALID_KEY = 'abc123'

@app.route('/info')
def info():
    api_key = request.headers['X-API-KEY']
    if api_key = VALID_KEY:
        return 'Access allowed'
    else:
        return 'Access denied', 403

medium

A. Using single equals (=) instead of double equals (==) in if condition

B. Accessing headers with request.headers.get() instead of []

C. Missing return type for response

D. Route decorator syntax is incorrect

Solution

1. Step 1: Check if condition syntax

   The if statement uses '=' which is assignment, not comparison.

2. Step 2: Correct comparison operator

   Use '==' to compare api_key and VALID_KEY for equality check.

3. Final Answer:

   Using single equals (=) instead of double equals (==) in if condition -> Option A

4. Quick Check:

   Comparison needs '==' not '=' [OK]

Hint: Use '==' for comparison, '=' is assignment [OK]

Common Mistakes:

• Confusing '=' with '==' in conditions
• Thinking request.headers['X-API-KEY'] is wrong
• Believing return type must be explicit

5. You want to protect multiple Flask routes using the same API key check without repeating code. Which approach is best to implement this efficiently?

hard

A. Copy the API key check code inside every route function

B. Check the API key only in the first route and assume others are safe

C. Create a decorator function that checks the API key before running the route function

D. Use a global variable to store the API key and skip checks

Solution

1. Step 1: Understand code reuse for API key checks

   Repeating code in every route is inefficient and error-prone.

2. Step 2: Use a decorator to wrap routes

   A decorator can run the API key check before the route logic, applying it to many routes cleanly.

3. Final Answer:

   Create a decorator function that checks the API key before running the route function -> Option C

4. Quick Check:

   Decorator = reusable API key check [OK]

Hint: Use decorators to avoid repeating API key checks [OK]

Common Mistakes:

• Copy-pasting code in every route
• Skipping checks on some routes
• Using global variables to bypass security