Flask

The APIToolkit Flask SDK is designed to seamlessly integrate Flask applications with APIToolkit’s monitoring and analytics services. With this SDK, you can effortlessly collect and analyze key metrics from your Flask application.

Installation

Install via pip: Use pip to install the APIToolkit Flask SDK.
```
pip install apitoolkit-flask
```
Verify Installation: You can verify the SDK installation by importing it in a Python shell.
```
import apitoolkit_flask
```

Troubleshooting

Installation Fails: Try upgrading pip and setuptools, then attempt the installation again.
Import Errors: Make sure you’re working within the Python environment where the SDK was installed.

Usage

Importing the SDK

Locate Main File: Navigate to the main Python file where your Flask application is defined.

Import SDK: Import the APIToolkit Flask SDK.

from apitoolkit_flask import APIToolkit

Initialization

Initialize the APIToolkit SDK with your Flask app and API key.

from Flask import Flask
from apitoolkit_flask import APIToolkit

app = Flask(__name__)

apitoolkit_client = APIToolkit(api_key='YOUR_API_KEY')

# register before_request function
@app.before_request
def before_request():
    apitoolkit.beforeRequest()

# register after_request function
@app.after_request
def after_request(response):
    apitoolkit.afterRequest(response)
    return response

# rest of your app
@app.route('/hello/<name>', methods=['GET', 'POST'])
def sample_route(name):
    return {"Hello": "Hello " + name}

app.run(debug=True)

Configuration Options

Customizing the APIToolkit Flask SDK to your specific needs is straightforward. You can pass various options when initializing the SDK to tailor its behavior.

Required Parameters

api_key: Your unique API key provided by APIToolkit, essential for authentication.
```
api_key="YOUR_API_KEY"
```

Optional Parameters

redact_headers: A list of HTTP header names you wish to redact from the data sent to APIToolkit.
```
redact_headers=["Authorization", "Cookie"]
```
redact_request_body: A list of JSONPath expressions for specifying which fields in the request body should be redacted.
```
redact_request_body=["$.user.password", "$.creditCard.number"]
```
redact_response_body: Similar to redact_request_body, but for the response body.
```
redact_response_body=["$.api_key", "$.user.social_security_number"]
```
debug: A boolean value that enables debug mode.

Redacting Sensitive Information

Protecting sensitive information is a crucial aspect of any application. The APIToolkit Flask SDK offers various options for redacting sensitive data from your API requests and responses.

Redacting Headers

To redact specific headers from being sent to APIToolkit’s servers, you can use the redact_headers option. Specify the headers to be redacted as a list:

redact_headers = ["Authorization", "X-Secret-Token"]

Redacting Request and Response Fields

For redacting specific fields in the request and response bodies, you can use the redact_request_body and redact_response_body options. Provide JSONPath expressions to specify which fields should be redacted:

redact_request_body = ["$.password", "$.user.credit_card"]
redact_response_body = ["$.token", "$.user.ssn"]

Example: Full Redaction Configuration

Here’s how you can include all redaction options in your SDK initialization:

from Flask import Flask
from apitoolkit_flask import APIToolkit

app = Flask(__name__)

# Initialize APIToolkit with redaction options
apitoolkit_client = APIToolkit(
    api_key="YOUR_API_KEY",
    redact_headers=["Authorization", "X-Secret-Token"],
    redact_request_body=["$.password", "$.user.credit_card"],
    redact_response_body=["$.token", "$.user.ssn"]
)

# register before_request function
@app.before_request
def before_request():
    apitoolkit.beforeRequest()

# register after_request function
@app.after_request
def after_request(response):
    apitoolkit.afterRequest(response)
    return response

# rest of your app
@app.route('/hello/<name>', methods=['GET', 'POST'])
def sample_route(name):
    return {"Hello": "Hello " + name}

app.run(debug=True)

By incorporating these redaction options, you can ensure that sensitive data is protected before it leaves your server.

Conclusion

This documentation has aimed to provide a comprehensive guide for integrating the APIToolkit Flask SDK into your Flask applications. From installation and basic usage to advanced features and troubleshooting, the SDK offers a range of functionalities designed to make monitoring and analytics as straightforward as possible.

By leveraging the APIToolkit Flask SDK, you can enhance the reliability, security, and performance of your Flask applications. Whether you’re running a small project or an enterprise-level service, APIToolkit provides the tools you need to maintain optimal operation and gain valuable insights into your application’s behavior.