Home/Docs/Setup Guide
SETUP GUIDE

Get Started in 2 Minutes

Sign up, point to your backend, and start proxying. No code changes required.

4-Step Quick Start

01

Sign Up

Create your free account at backport-io.vercel.app/auth/signup. Enter your email and choose a password.

Visit: backport-io.vercel.app/auth/signup
02

Verify Your Email

A 6-digit OTP is sent to your email. Enter it to verify your account. Your API key is returned automatically after verification.

Check your inbox for the OTP code
03

Set Your Backend URL

Go to Dashboard → Settings → Target Backend URL. Enter the URL of your existing API server (e.g. https://my-api.example.com).

Dashboard → Settings → Target Backend URL
04

Start Proxying

Send requests through the Backport gateway using your API key. All traffic passes through WAF, rate limiting, caching, and idempotency before reaching your backend.

curl -H "X-API-Key: bk_xxx" https://backport-io.onrender.com/proxy/your-endpoint

Prerequisites

What You Need

  • A web browser
  • An email account (for verification)
  • An existing API or backend server

Common Use Cases

Protect Public APIs

Block malicious requests before they hit your server. Enable WAF from dashboard settings.

WAF: ON | Rate Limit: 60 req/min | Cache: OFF

Speed Up Read Operations

Cache frequently accessed GET data. Ideal for analytics, lists, and dashboard endpoints.

WAF: ON | Rate Limit: 60 req/min | Cache: ON | TTL: 5 min

Prevent Duplicate Payments

Use idempotency keys on checkout endpoints to prevent double-charging on retry.

WAF: ON | Rate Limit: 30 req/min | Idempotency: ON

Ready to Get Started?

Free plan available. No credit card required.

Create Free Account Read Full Docs