Skip to main content

A middleware to monetize Django APIs with Stripe and the 402 Error Code

Project description

Django API Gate 🏦

Monetize your Django API in minutes. django-api-gate is a drop-in middleware that turns your API into a metered, paid service. It connects to the API Gate Hub protocol to handle API keys, credit balances, and billing automatically.

🚀 Features

Instant Paywall: Protects your API routes with one line of code.

Metered Billing: Deducts credits per request automatically.

Zero-Config Banking: No need to set up Stripe or Ledger logic yourself—API Gate Hub handles the backend.

High Performance: Uses persistent connection pooling for minimal latency impact (~20ms).

📦 Installation

pip install django-api-gate

⚙️ Configuration

  1. Add into your settings.py:

MIDDLEWARE = [

'django.middleware.security.SecurityMiddleware',

'django.contrib.sessions.middleware.SessionMiddleware',

'django.middleware.common.CommonMiddleware',

# ...

'django_api_gate.middleware.ApiGateMiddleware', # <--- Add this

# ...

]

  1. Go to API Gate Hub and create an account.

  2. Copy your API Key from the dashboard.

  3. Add your API Key to settings.py:

API_GATE_API_KEY = "your-merchant-uuid-here"

OPTIONAL VARIABLES:

Change which URLS are protected (Default: '/api/'):

API_GATE_URL_PREFIX = "/v1/"

Change the cost per request (Default: 1 credit):

API_GATE_PRICE = 5

🛠️ Usage

Once installed, any request to your protected URL prefix (e.g., /api/data) will require an API Gate Key in the header:

curl -H "X-Api-Key: 'customer-uuid-here'" https://yoursite.com/api/data

If a user runs out of credits, they receive a standard 402 Payment Required response:

{ "error": "Insufficient Credits", "balance": 0, "top_up_url": "https://api-gate-hub.onrender.com" }

If a user is missing a key, they receive a standard 401 Unauthorized response:

{ "error": "Unauthorized", "message": "Access requires a prepaid API Key in header 'X-Api-Key'.", "portal_url": "https://api-gate-hub.onrender.com" }

🏗️ Architecture

This library operates as a Spoke in a Hub-and-Spoke financial model.

The Hub: The API Gate Hub (Ledger, Stripe Processing, User Accounts).

The Spoke: Your Django App (Product, Logic, Value).

When a request comes in, this middleware pings the Hub to verify funds and transfer credits from the Consumer to the Merchant.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_api_gate-0.0.7.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_api_gate-0.0.7-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file django_api_gate-0.0.7.tar.gz.

File metadata

  • Download URL: django_api_gate-0.0.7.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.6

File hashes

Hashes for django_api_gate-0.0.7.tar.gz
Algorithm Hash digest
SHA256 7fe6e1d516d6800341b6481acaa9454481698c9bde5cb34553e05d7a99630953
MD5 85e5401879ec9d6b4fe7f9e38469a692
BLAKE2b-256 d5bfaa1452ac3c39ea9be9157f0c9666a5ff7702139f5c144973f7d4903388d9

See more details on using hashes here.

File details

Details for the file django_api_gate-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for django_api_gate-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8d136d359904f73140b30ce5eb60b0f811affe83f2e8c2a43b79223acbeecb59
MD5 4165330f46e7219c6863c8289996e8bc
BLAKE2b-256 8a7fb58c22f9d286012425ca156634fa4c37b33c8e5db65666e6113298d8599b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page