Documentation

Comprehensive guides and API reference to integrate G8KEPR into your application and protect your APIs in minutes.

Quick Start Guide

G8KEPR is designed to be deployed in minutes. This guide will walk you through installation, configuration, and making your first protected API request.

Prerequisites

  • • Node.js 18+ or Python 3.9+
  • • An existing API application
  • • G8KEPR account (sign up at app.g8kepr.com)
  • • 5 minutes of your time

Step 1: Installation

Install the G8KEPR SDK for your platform:

Node.js / JavaScript
npm install @gatekeeper/sdk
Python
pip install gatekeeper-sdk
Go
go get github.com/gatekeeper/sdk-go

Step 2: Get Your API Key

After signing up, navigate to your dashboard and copy your API key from the "API Keys" section.

Security Note: Never commit your API key to version control. Always use environment variables.

Step 3: Initialize G8KEPR

Express.js Middleware
const Gatekeeper = require('@gatekeeper/sdk');

const gatekeeper = new Gatekeeper({
  apiKey: process.env.GATEKEEPER_API_KEY,
  environment: 'production'
});

// Protect all routes
app.use(gatekeeper.middleware());

// Or protect specific routes
app.use('/api', gatekeeper.middleware({
  rateLimit: { requests: 100, window: '1m' }
}));
FastAPI (Python)
from gatekeeper import Gatekeeper, middleware

gatekeeper = Gatekeeper(
    api_key=os.getenv("GATEKEEPER_API_KEY"),
    environment="production"
)

app = FastAPI()
app.add_middleware(
    middleware.GatekeeperMiddleware,
    gatekeeper=gatekeeper,
    rate_limit={"requests": 100, "window": "1m"}
)

Step 4: Test Your Protection

Make a request to your API and check the G8KEPR dashboard to see it being monitored in real-time.

✓ Setup Complete!

Your API is now protected by G8KEPR. Visit your dashboard to:

  • • View real-time traffic and threats
  • • Configure rate limits and security rules
  • • Set up alerts and notifications
  • • Generate compliance reports

Need Help?

Our support team is here to help you get started