Platform integration overview

The REST API manages the control plane around proxy traffic. It does not carry proxy requests; it provisions the users, products, credentials, limits, and reporting surfaces that make those requests possible.

Direct integration

Read the authenticated profile, inspect packages and orders, generate proxy access, review analytics, and configure account-level webhooks.

Reseller integration

Create sub-users, allocate or subtract bytes, inspect user orders, generate access, and synchronize usage into your own billing system.

API boundary

Your backend
   │
   ├── HTTPS + JSON ──> https://api.proxyrequest.com/api/v1
   │                         ├── users / orders / packages
   │                         ├── locations / proxy generation
   │                         └── analytics / webhooks / API keys
   │
   └── HTTP or SOCKS5 ──> proxy gateway ──> destination

Platform tokens must never be sent to proxy gateway ports. Proxy usernames and passwords must never be placed in the API Authorization header.

COMMON RESELLER PATH

From account access to usage reconciliation

1. 01

   Authenticate the backend

   Use a static API key for server-to-server work or obtain a JWT through the login flow.

   Authorization: Static YOUR_API_KEY
2. 02

   Read the catalog

   Load packages and package-specific locations before presenting choices to a customer.

   GET /packages
3. 03

   Provision a sub-user

   Create the platform user and persist its returned identifier next to your customer record.

   POST /users
4. 04

   Allocate integer bytes

   Convert the commercial plan once, then send the exact byte amount to the data endpoint.

   POST /users/{id}/data/add
5. 05

   Generate proxy access

   Use the selected package and targeting identifiers to produce connection credentials.

   POST /proxies/generate
6. 06

   React and reconcile

   Process signed webhook batches for changes and compare them with analytics reports.

   GET /analytics/overall

Core concepts

Concept	Integration rule
Main user	The authenticated account and authorization boundary
Sub-user	A reseller-managed customer; always map its API ID to your internal customer ID
Package	Product definition and targeting capability source
Order	Purchased or assigned access used by credentials and accounting
Data	Integer bytes, not an implicit GB value
Analytics	Query surface for dashboards and reconciliation
Webhook	Asynchronous notification surface; not the only source of truth

Continue by responsibility

Secure API accessBase URL, JWT, static keys, pagination, and error bodies.

Provision customersThe end-to-end reseller sequence and recovery checkpoints.

Generate connectivityJoin packages, orders, locations, and proxy generation.

Consume eventsCreate a webhook and verify the accountant signature.