xProxy Market — Vendor Onboarding Guide

1. Overview

xProxy Market (market.xproxy.io) is a proxy marketplace where customers buy mobile proxy access. As a Vendor, you provide the actual proxy infrastructure — modems, SIM cards, and servers — while the marketplace handles payments, customer accounts, and order management.

This guide walks you through becoming a vendor and connecting your xProxy dashboard so that when a customer purchases one of your proxy plans, the marketplace automatically provisions the proxy on your hardware and delivers credentials to the customer.

What you get as a vendor:

  • Your proxy plans listed on the marketplace for customers to purchase.

  • Automatic provisioning — no manual work when a sale happens.

  • Revenue share — you earn 70% of each sale (configurable by admin).

  • Dashboard to track earnings, manage plans, and manage API keys.

2. Prerequisites

Before you begin, ensure you have:

A running xProxy instance — Your xProxy dashboard must be accessible from the internet (public IP). For example: http://YOUR_PUBLIC_IP:8080

xProxy webhook support — Your xProxy version must support the marketplace webhook endpoint (/webhook/provision). Make sure your xProxy software is up to date.

An email address — You need a valid email address to register on the marketplace.

3. Step 1 — Create an Account

1. Open your browser and go to:

https://market.xproxy.io/register

2. Fill in the registration form:

Field

Description

Username

Choose a unique username

Email

Your email address (must be verified)

Password

At least 6 characters



3. Complete the Cloudflare Turnstile captcha verification.

4. Click "Create Account".

5. Check your email for a verification link. Click it to verify your account.

6. Log in with your email and password at:

https://market.xproxy.io/login

4. Step 2 — Apply as Vendor

Once logged in, you need to apply for vendor status. This tells the admin you want to sell proxies on the marketplace.

1. In the top navigation bar, you will see a "Become Vendor" link. Click it.

2. A confirmation dialog will appear asking if you want to apply as a vendor. Click "OK" / "Confirm".

3. Your application is submitted instantly. The navigation bar will now show "Vendor Pending…" in orange text, confirming your application is under review.

Note: Your account role remains "user" while your application is pending. You will NOT have access to vendor features until the admin approves your application. The "Become Vendor" link disappears and is replaced by "Vendor Pending…" so you know your application was received.

5. Step 3 — Wait for Admin Approval

After applying, the marketplace admin will review your account. During this time, the navigation bar shows "Vendor Pending…" in orange.

Once the admin approves your application:

  • Your account role changes from "user" to "vendor".

  • The "Vendor Pending…" text is replaced by a "Vendor" link in the navigation bar.

  • Clicking "Vendor" opens your Vendor Dashboard where you can create plans, generate API keys, and view earnings.

If rejected: Your role stays "user" and the "Become Vendor" link reappears in the navigation bar, allowing you to apply again if needed.

Approval is typically done within 24 hours. Contact the admin via Telegram if it takes longer.

6. Step 4 — Access the Vendor Dashboard

After approval, click "Vendor" in the navigation bar. You will see your Vendor Dashboard with:

Dashboard Cards:

Card

Description

Balance

Your current unpaid earnings balance

Total Earned

Total amount earned from all sales

Total Paid Out

Amount already paid out to you

Commission Rate

Your revenue share percentage (default: 70%)

Dashboard Tabs:

My Plans — Create and manage your proxy plans.

API Keys — Generate and manage API keys for xProxy integration.

Earnings — View your earnings from customer purchases.

7. Step 5 — Generate an API Key

The API key is how your xProxy instance authenticates with the marketplace. You need one API key per xProxy server.

Steps:

1. Go to the Vendor Dashboard → "API Keys" tab.

2. Click "+ Generate API Key".

3. Fill in the form:

Field

Example

Description

Name

My xProxy Server

A friendly name to identify this key

Webhook URL

http://YOUR_IP:8080/webhook

Your xProxy public URL. Replace YOUR_IP with your server's public IP and 8080 with your dashboard port.



4. Click "Generate".

5. Your API key will be displayed. It looks like:

pm_AbCdEfGhIjKlMnOpQrStUvWxYz0123456789AbCdEfGhIjKlMn



IMPORTANT: Copy this API key immediately and save it somewhere safe. It will NOT be shown again. If you lose it, you must delete the key and generate a new one.



6. Click "Done" to close the dialog.

What the API key is used for:

  • Authenticating API requests from your xProxy to the marketplace (plan sync, health reports, etc.).

  • Verifying webhook signatures — the marketplace signs webhook payloads so your xProxy can verify they are genuine.

8. Step 6 — Configure xProxy

Now configure your xProxy instance to connect to the marketplace using the API key you just generated. This section covers both what to configure in the xProxy dashboard and how the connection works behind the scenes.

8.1 — Open the xProxy Admin Panel

1. Open your browser and go to your xProxy admin panel. The URL is typically:

http://YOUR_SERVER_IP:YOUR_PORT

Replace YOUR_SERVER_IP with the public IP address of your xProxy server, and YOUR_PORT with the dashboard port (commonly 5555, 5050, or 8080 depending on your setup).

8.2 — Navigate to Marketplace Settings

2. In the xProxy admin panel, navigate to the Marketplace Integration page. Depending on your xProxy version, this may be under:

  • Selling Platform → Marketplace Integration

  • Selling Platform → API / Webhook

  • Selling Platform → ProxyMarket

8.3 — Enter the Connection Settings

3. Enter the following settings:

Setting

Value

Description

Marketplace URL

https://market.xproxy.io/api

The ProxyMarket API base URL. Do not change this.

API Key

pm_AbCd... (from Step 5)

The full API key you generated in the Vendor Dashboard. Starts with "pm_".

Webhook URL

http://YOUR_IP:PORT/webhook

This is the URL you entered when generating the API key (Step 5). xProxy uses this to receive provision/deprovision commands from the marketplace.

Test Connection

 

After entering your API key and base URL, click "Test Connection" to verify that XProxy can reach the marketplace API. A success message confirms the connection. If it fails, check your API key and network connectivity.

Health Report

Enable (every 5 min)

Sends periodic health status (online/offline, current IP, latency) for each proxy to the marketplace.



4. Click "Save" or "Apply".

5. Your xProxy will immediately sync all available proxy ports (modems) to the marketplace. You can verify this by checking the Vendor Dashboard → "My Plans" tab.

8.4 — How the Connection Works

Once configured, the following happens automatically:

Plan Sync (xProxy → Marketplace): xProxy calls POST /api/integration/plans/sync to push all your modem ports as proxy plans. Each port becomes a purchasable plan on the marketplace. Plans are auto-approved for API-integrated vendors.

Health Reports (xProxy → Marketplace): Every 5 minutes, xProxy sends POST /api/integration/health with the status (online/offline), current IP, and latency for each port.

Stock Updates (xProxy → Marketplace): When a modem goes online or offline, xProxy calls PATCH /api/integration/plans/stock to update availability in real time.

Provision Webhook (Marketplace → xProxy): When a customer purchases a proxy, the marketplace sends a POST request to your webhook URL with the order details. xProxy automatically provisions the proxy and returns credentials (IP, port, username, password) to the marketplace.

Deprovision Webhook (Marketplace → xProxy): When an order expires or is cancelled, the marketplace sends a deprovision webhook. xProxy revokes the customer credentials and frees up the port.

9. Step 7 — Sync Plans via API

If your xProxy has built-in marketplace support (Step 6) and Auto Sync is enabled, plans sync automatically when xProxy starts and whenever port configuration changes. You do NOT need to do anything manually in this case.

However, if you need to sync manually or build a custom integration outside of xProxy, you can use the Integration API directly:

Sync plans:

POST https://market.xproxy.io/api/integration/plans/sync



Headers:

X-API-Key: pm_your_api_key_here
Content-Type: application/json



Example request body:

[
{
"external_id": "port-1",
"name": "US Mobile 4G - Port 1",
"proxy_type": "mobile",
"protocol": "HTTP",
"country": "United States",
"duration_days": 30,
"duration_unit": "days",
"bandwidth_gb": null,
"price_usd": 25.00,
"stock": 1,
"is_active": true
}
]



Plans synced via API are automatically approved and listed on the marketplace. For full API documentation, see the VENDOR_INTEGRATION_GUIDE.md file.

10. Step 8 — Verify Integration

After syncing, verify everything is working:

1. Go to the marketplace homepage (https://market.xproxy.io).

2. Check that your proxy plans appear in the plan listing.

3. In your Vendor Dashboard → "My Plans" tab, verify all plans show status "Approved" and "Active".

4. (Optional) Create a test order yourself or ask the admin to run a test. When a payment is confirmed, you should see the provision webhook being called on your xProxy.

Tip: Check your xProxy logs for incoming webhook requests from the marketplace. Successful provision will return proxy credentials (IP, port, username, password) back to the marketplace.

11. How It Works (Order Flow)

Here is what happens when a customer buys one of your proxies:

1. Customer finds your plan on the marketplace and clicks "Buy".

2. Customer pays using cryptocurrency (USDT, BTC, etc.) via the payment gateway.

3. Payment confirmed — the marketplace receives a webhook from the payment processor.

4. Marketplace calls your xProxy — sends a POST request to your webhook URL (/webhook/provision) with the order details (plan ID, customer ID, duration, etc.).

5. Your xProxy provisions the proxy — creates a user account on the modem/port, generates credentials (username + password), and returns them in the webhook response.

6. Credentials delivered to customer — the marketplace stores the credentials and shows them to the customer in their "My Orders" page.

7. You earn revenue — 70% of the sale amount is credited to your vendor balance.

12. Troubleshooting

Plans not showing on the marketplace

Check that is_active is true and stock is greater than 0. Also verify your API key is active in the "API Keys" tab.



xProxy not syncing plans

Verify the Marketplace URL is set to https://market.xproxy.io/api (not /api/integration). Check that the API key starts with "pm_" and is pasted correctly without extra spaces. In the xProxy dashboard, check the sync log for any error messages.



Webhook not being called

Verify the Webhook URL you entered when generating the API key is correct and reachable from the internet. The URL should be http://YOUR_PUBLIC_IP:PORT/webhook (not localhost). Check that your firewall allows incoming connections on the webhook port. Test by accessing the webhook URL from an external device.



Signature verification failing

The marketplace signs webhooks using SHA256(your_raw_api_key) as the HMAC secret — NOT the raw API key. If you updated your API key, make sure xProxy also has the new key. Delete the old key and generate a new one if issues persist.



Customer not receiving credentials

Check your xProxy logs to see if the provision webhook returned status "provisioned" along with proxy_ip, proxy_port, proxy_username, and proxy_password. If you return status "pending", you must push credentials within 5 minutes via the /api/integration/orders/{order_id}/credentials endpoint.



API key rejected (401 error)

Make sure you are sending the correct API key in the X-API-Key header. Check that the key is active (not disabled) in the Vendor Dashboard. If you recently regenerated the key, update it in xProxy settings as well.



Modem goes offline but marketplace still shows plan as available

Ensure Health Reports are enabled in xProxy (every 5 minutes). xProxy should automatically call PATCH /api/integration/plans/stock with stock: 0 when a modem goes offline. Check xProxy logs for stock update errors.



13. FAQ

Q: How many API keys can I create?

A: You can create multiple API keys — one per xProxy server/instance. Each key has a unique name.



Q: Can I change the webhook URL later?

A: Currently you need to delete the old key and generate a new one with the updated URL.



Q: What is the commission rate?

A: The default split is 70% vendor / 30% platform. This may be adjusted by the admin.



Q: Can I create plans manually (without API)?

A: Yes! In the Vendor Dashboard → "My Plans" tab, click "+ Add Plan" to create plans through the web UI. However, these plans require admin approval and credentials must be pre-configured.



Q: How do I get paid?

A: Payouts are managed by the marketplace admin. Your earnings accumulate in your vendor balance and are paid out periodically. Contact the admin for payout schedule details.



Q: What currencies does the marketplace accept?

A: The marketplace accepts cryptocurrency payments (USDT, BTC, ETH, and more) via UseGateway.



Q: Is my API key permanent?

A: Yes, API keys do not expire. You can disable or delete them at any time from the Vendor Dashboard.





Need Help?

If you have questions or run into issues:

  • Contact the marketplace admin via Telegram.

  • Open a support ticket on the marketplace (Help → Tickets).

  • Refer to the VENDOR_INTEGRATION_GUIDE.md for detailed API documentation.

Share post
You must be logged in to post a comment
Top
Contact US via Telegram
Contact Us via Messenger