SP StackProxySEO-first proxy commerce
Sign in Start free
Home / API

API access designed for both developers and buyers

The API page explains dashboard authentication, API keys, whitelists, and the supplier-backed order lifecycle so serious users can integrate without opening support tickets.

Authentication

How access works

  • Customers sign in to the dashboard with their account credentials.
  • API users generate service-specific keys from the account area.
  • Optional source-IP whitelists restrict which servers can call the API.
  • Residential and mobile operations expose additional configuration surfaces after login.

Live integration summary

This page now reflects the real PHP SDK setup pattern: the API key is placed in the URL path, not in a bearer token header.

{
    "connection": {
        "connected": true,
        "ping": 1775763577,
        "message": "SDK-style key path and the lightweight ping endpoint verified successfully."
    },
    "client": {
        "site_base_url": "https://proxy-seller.com",
        "api_base_uri": "https://proxy-seller.com/personal/api/v1/{API_KEY}/",
        "masked_key": "cf0f************************5cbd",
        "whitelist_count": 0,
        "payment_id": 1,
        "generate_auth": "N",
        "sdk": "proxy-seller/user-api-php"
    },
    "draft": {
        "supplier": "proxy-seller",
        "sdk_reference": "proxy-seller/user-api-php",
        "endpoint_template": "https://proxy-seller.com/personal/api/v1/{API_KEY}/order/calc",
        "api_key_present": true,
        "masked_key": "cf0f************************5cbd",
        "payment_id": 1,
        "generate_auth": "N",
        "whitelist_count": 0,
        "payload": {
            "product": "datacenter_ipv4",
            "country": "US",
            "quantity": 25,
            "period_id": 30,
            "authorization": "userpass",
            "coupon": "",
            "customTargetName": "SEO storefront example"
        },
        "next_step": "Map the selected product form to order/calc first, then order/make after validation."
    }
}

What was verified

The key was checked using the same base URI shape as the official PHP SDK and through read-only API calls.

  • Base URI pattern: `https://proxy-seller.com/personal/api/v1/{API_KEY}/...`
  • SDK package: `proxy-seller/user-api-php`
  • Read-only checks: `system/ping` and `balance/get`
  • Configured locally: `inc/config.local.php` with frontend-safe masking on this page

Example integration payload

This is the request shape your checkout layer can send into `order/calc` before creating an order.

{
    "supplier": "proxy-seller",
    "sdk_reference": "proxy-seller/user-api-php",
    "endpoint_template": "https://proxy-seller.com/personal/api/v1/{API_KEY}/order/calc",
    "api_key_present": true,
    "masked_key": "cf0f************************5cbd",
    "payment_id": 1,
    "generate_auth": "N",
    "whitelist_count": 0,
    "payload": {
        "product": "datacenter_ipv4",
        "country": "US",
        "quantity": 25,
        "period_id": 30,
        "authorization": "userpass",
        "coupon": "",
        "customTargetName": "SEO storefront example"
    },
    "next_step": "Map the selected product form to order/calc first, then order/make after validation."
}

Recommended endpoint groups

Use the supplier documentation as your source of truth while keeping your own internal service layer stable.

  • Catalog: list products, countries, and available stock metadata
  • Calculator: estimate bandwidth or IP-duration purchases before checkout
  • Orders: create, renew, and inspect lifecycle state
  • Inventory: fetch active lists, credentials, and replacement state
  • Residential controls: manage package settings, sub-users, rotation, and session TTL
  • Auth tools: fetch whitelist records and toggle auth activation