Architecture

Architectural Components

SuperAPI's architecture consists of these key components working together as an integrated gateway:

The SuperAPI Gateway serves as the entry point for all API requests, handling multiple functions within a single integrated service. It routes traffic to either its internal cache or your origin API, stores and retrieves cached API responses, monitors your database's replication stream to detect data changes, and processes these changes to keep the cache fresh.

SuperAPI connects to your VPC environment where your load balancer, API servers, and database reside, integrating seamlessly with your existing infrastructure.

This integrated approach means you don't need to maintain or configure any additional components - SuperAPI handles all caching functionality within a single managed service.

This architecture enables SuperAPI to:

1. Serve cached responses when possible for maximum performance
2. Forward requests to your origin when necessary
3. Monitor database changes to keep the cache fresh
4. Intelligently invalidate only affected cache entries

The result is significantly improved API performance without sacrificing data freshness or requiring changes to your existing API implementation.

Deployment and Integration

Proxy Architecture

SuperAPI functions as a proxy between your clients and your origin API. When a request arrives, SuperAPI first checks for a valid cached response. For cache hits, it immediately returns the cached response without contacting your origin. For cache misses, it forwards the request to your origin, caches the appropriate response, and returns it to the client.

This proxy design allows SuperAPI to seamlessly integrate with your existing infrastructure without requiring changes to your API implementation.

Managed Deployment

When you create and deploy a gateway through the SuperAPI platform website, the entire service is fully deployed and maintained by the SuperAPI team. This managed approach eliminates the need for you to handle any infrastructure management, updates, or scaling concerns.

You simply configure your gateway, connect your database, and define your endpoints through the SuperAPI dashboard - the SuperAPI team handles everything else.

Hosting Options

SuperAPI is cloud-based and can be deployed in two ways:

1. SuperAPI Cloud (default): Your gateway is hosted on SuperAPI's cloud infrastructure, managed entirely by the SuperAPI team. The SuperAPI instance is deployed in the exact region and cloud provider you select when creating your gateway, ensuring optimal proximity to your application and users.

2. Enterprise Plan: For customers on the enterprise plan, SuperAPI can be deployed directly to your company's cloud environment, giving you additional control and keeping traffic within your network perimeter.

In either case, the deployment and maintenance are fully managed by SuperAPI, with no infrastructure management required from your team.

Network Placement

By default, SuperAPI is deployed in front of your load balancer, acting as the first point of contact for API requests before they reach your infrastructure. For enterprise customers, SuperAPI can also be deployed behind your load balancer if required by your network architecture or security policies.

Infrastructure Requirements

SuperAPI is a complete, fully-managed solution that includes all necessary caching infrastructure. You don't need to provision Redis or any other cache databases. When you deploy a gateway, SuperAPI automatically provisions and configures all required caching infrastructure, with no additional resources needed from your end.

This one-click approach ensures you can start caching your APIs immediately without worrying about infrastructure setup or maintenance.

Cloud Provider Support

SuperAPI can be deployed to the following cloud providers and regions:

Security Considerations

SuperAPI is designed with security in mind:

• Database Access: The database connection uses a read-only user with minimal permissions
• Data Isolation: Each customer's data is completely isolated
• Enterprise Options: For enterprise customers, SuperAPI can be deployed within your own cloud environment
• Authentication Support: SuperAPI supports JWT authentication and can maintain proper cache isolation based on identity

For more details on authentication and security, see our Authentication documentation.

Next Steps

Now that you understand how SuperAPI fits into your architecture, you're ready to:

1. Create your first gateway
2. Connect your database
3. Configure your endpoints