Zuplo

API Key Authentication

Secure Your Sanic API with API Keys

The Zuplo API Gateway protects your backend API from unauthorized access, abuse, and overload. Add API key authentication to your Sanic API in minutes.

Secure Access

Authenticate every request before it reaches your backend.

Control Costs

Set rate limits and quotas to prevent runaway usage.

Ensure Reliability

Shield your backend from overload with traffic management.

How it works

The Zuplo API Gateway sits between your clients and your Sanic backend, providing a secure layer of protection and control.

Client
Zuplo API Gateway

Customer VPC

Backend

Step-by-step tutorial

It takes only a few minutes to put Zuplo in front of your Sanic backend, adding API key authentication, and configuring your origin to trust requests from Zuplo using shared secrets.

1

Create a Route in Zuplo

First, create a new route in your Zuplo project that will proxy requests to your Sanic backend. This route will be the entry point for your API consumers.

Creating a route in Zuplo
Learn how to create routes

📄 OpenAPI native. Import your existing OpenAPI spec to instantly create routes and power your API documentation .

2

Add API Key Authentication Policy

Add the API Key Authentication policy to your route. This policy validates incoming API keys and ensures only authorized consumers can access your API.

Adding API Key Authentication policy in Zuplo
API Key Authentication docs

🔐 Leaked key? No problem. As a GitHub Secret Scanning partner, Zuplo can automatically revoke exposed keys before they can be exploited.

3

Add Set Header Policy

Add the Set Header policy to your route. This policy sets the shared secret header on requests to ensure only requests from Zuplo are accepted by your API.

Adding Set Header policy in Zuplo
Set Header Policy docs
4

Secure Your Sanic API with the Shared Secret

Configure your Sanic backend to validate the shared secret header set by Zuplo. This ensures that only requests coming through your Zuplo gateway are accepted.

Python
from sanic import Sanic, response
from sanic.request import Request
from sanic.exceptions import SanicException
import os
import hmac
import hashlib

app = Sanic("SecureAPI")

# Middleware to validate shared secret header
async def validate_shared_secret(request: Request):
    expected_secret = os.getenv("SHARED_SECRET")

    if not expected_secret:
        raise SanicException("Server configuration error", status_code=500)

    secret = request.headers.get("x-shared-secret")

    if not secret:
        raise SanicException("No secret provided", status_code=401)

    # Use HMAC to ensure a timing-safe comparison
    if not hmac.compare_digest(secret, expected_secret):
        raise SanicException("Invalid secret", status_code=401)

# Add middleware
@app.on_request
async def check_secret_middleware(request: Request):
    await validate_shared_secret(request)

# Example protected route
@app.get("/protected")
async def protected_route(request: Request):
    return response.json({"message": "Access granted"})

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)
5

Call Your API Through Zuplo

Now you can call your API through Zuplo using an API key. The request will be authenticated at the gateway, and securely forwarded to your Sanic backend.

Terminalbash
curl -X GET \
  'https://your-api.zuplo.dev/your-route' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Ready to secure your API?

Get started with Zuplo for free and add API key authentication to your Sanic API in minutes.

Start for Free Read the Docs