Getting Started with RequestRocket

This guide will walk you through the essential steps to get started with RequestRocket and create your first API proxy.

Quick Start Guide

Visit the RequestRocket platform and create a new account or sign in with your existing credentials.

Create an Organisation

Organisations allow you to manage team members, projects, and access controls in one place.

Click the user profile icon (or account menu) in the top right corner of the screen
Click "Organisations" in the dropdown menu
On the Clients tab (Your Orgs), click "Create"
Enter your organisation details
Click "Create" to finalize

Create a Target Credential

This credential is used by RequestRocket to authenticate with your target API.

Navigate to the Target Credentials section
Click "Create"
Choose a Region as your target will be in
Select the appropriate Auth Type for your target API
Configure the authentication details
Click "Create"

Enter your details carefully - they cannot be viewed or changed after creation!

Create a Target

Define the destination API you want to connect to.

Navigate to the Targets section
Click "Create"
Enter a descriptive Name
Select the same Region as your target credential
Enter the Base URL (e.g., https://api.example.com)
Click "Create"

Create a Proxy Credential

This is the credential your application will use to authenticate with RequestRocket's proxy API.

Navigate to the Credentials section
Click "Create"
Choose your Region as your target will be in
Select an Auth Type (API Key, Bearer Token, JWT, etc.)
Configure the authentication details
Click "Create"

Save your credential details securely - they cannot be viewed after creation!

Create a Proxy

Now combine your target and proxy credential into a proxy configuration.

Navigate to the Proxies section
Click "Create"
Enter a Proxy Name
Select the same Region as your credentials and target
Choose your Proxy Credential
Select your Target
Choose your Target Credential
Set the proxy to Active
Click "Create"

You'll receive a Base URL for your proxy - this is what your application will use!

You can assign an alias to your proxy that gives you a more meaningful URL to use.

Test Your Endpoint

Make a test request to your proxy using the provided Base URL and your proxy credential.

const response = await fetch('https://{Your_Proxy_Base_URL}/{target_path}', {
  headers: {
    'Content-Type': 'application/json',
    'Authorization': '{Your_Proxy_Credential}'
  }
});

// Check for successful proxy authentication
const proxyCode = response.headers.get('requestrocket-proxy-code');
console.log('Proxy Status:', proxyCode); // Should be 'proxy-access-granted'

const data = await response.json();
console.log(data);

import requests

response = requests.get(
    'https://{Your_Proxy_Base_URL}/{target_path}',
    headers={
        'Content-Type': 'application/json',
        'Authorization': '{Your_Proxy_Credential}'
    }
)

# Check for successful proxy authentication
proxy_code = response.headers.get('requestrocket-proxy-code')
print(f'Proxy Status: {proxy_code}')  # Should be 'proxy-access-granted'

data = response.json()
print(data)

package main

import (
    "encoding/json"
    "fmt"
    "io"
    "net/http"
)

func main() {
    client := &http.Client{}
    req, _ := http.NewRequest("GET", "https://{Your_Proxy_Base_URL}/{target_path}", nil)
    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "{Your_Proxy_Credential}")

    resp, _ := client.Do(req)
    defer resp.Body.Close()

    // Check for successful proxy authentication
    proxyCode := resp.Header.Get("requestrocket-proxy-code")
    fmt.Printf("Proxy Status: %s\n", proxyCode) // Should be 'proxy-access-granted'

    body, _ := io.ReadAll(resp.Body)
    var data map[string]interface{}
    json.Unmarshal(body, &data)
    fmt.Println(data)
}

import java.net.http.*;
import java.net.URI;

public class TestProxy {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://{Your_Proxy_Base_URL}/{target_path}"))
            .header("Content-Type", "application/json")
            .header("Authorization", "{Your_Proxy_Credential}")
            .GET()
            .build();

        HttpResponse<String> response = client.send(request, 
            HttpResponse.BodyHandlers.ofString());

        // Check for successful proxy authentication
        String proxyCode = response.headers()
            .firstValue("requestrocket-proxy-code").orElse("");
        System.out.println("Proxy Status: " + proxyCode); // Should be 'proxy-access-granted'

        System.out.println(response.body());
    }
}

curl -X GET "https://{Your_Proxy_Base_URL}/{target_path}" \
  -H "Content-Type: application/json" \
  -H "Authorization: {Your_Proxy_Credential}"

Look for the requestrocket-proxy-code: proxy-access-granted header in the response to confirm successful authentication!

Add a drop-in authentication and authorization layer in between all outbound API requests - instantly gathering telemetry data and creating an auditable trail of traffic into and out of your environment.

Building RESTful APIs

Use RequestRocket as a gateway layer to add authentication and authorization to your APIs.

Creating Mock APIs

Set up target APIs pointing to mock services for frontend development and testing.

Testing Third-Party Integrations

Safely test integrations with external APIs using RequestRocket's request logging and monitoring.

Tip: All components (proxy, credentials, and target) must be in the same region. Plan your regional deployment based on your application's geographic requirements.

What's Next?

Now that you have a working proxy, explore these topics:

Client Integration Guide

Learn how to integrate RequestRocket into your application

SaaS Integration Guide

Learn how to use RequestRocket to power customer integrations

Rules

Set up fine-grained access control

API Reference

Explore the full API documentation

Security Architecture

Understand how RequestRocket protects your data

Getting Started