Zuplo

API Key Authentication

Secure Your Pyramid API with API Keys

The Zuplo API Gateway protects your backend API from unauthorized access, abuse, and overload. Add API key authentication to your Pyramid 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 Pyramid 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 Pyramid 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 Pyramid 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 Pyramid API with the Shared Secret

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

Python
from pyramid.response import Response
from pyramid.view import view_config
from pyramid.settings import asbool
import os
from hmac import compare_digest

def validate_shared_secret(request):
    secret = request.headers.get('X-Shared-Secret')
    expected_secret = os.getenv('SHARED_SECRET')

    if not expected_secret:
        request.response.status = 500
        return {'error': 'Server configuration error'}

    if not secret:
        request.response.status = 401
        return {'error': 'No secret provided'}

    if not compare_digest(secret, expected_secret):
        request.response.status = 401
        return {'error': 'Invalid secret'}

    return None

@view_config(route_name='protected', renderer='json')
def protected_view(request):
    error_response = validate_shared_secret(request)
    if error_response:
        return error_response

    return {'message': 'Access granted'}

def main(global_config, **settings):
    from pyramid.config import Configurator

    with Configurator(settings=settings) as config:
        config.add_route('protected', '/protected')
        config.scan()

    return config.make_wsgi_app()
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 Pyramid 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 Pyramid API in minutes.

Start for Free Read the Docs