Skip to main content

​
Initial setup

We need the following information from sales/partner:
  1. Partner name: letters only
  2. Which DNS url they would like to use. This DNS name should be aliased to: brd.superproxy.io.
  3. Authorized IPs to add to our allowlist. Other IPs will be blocked from invoking our afiiliate APIs.
  4. List of products they to resell out of this list:

​
High level affiliate flow

To offer Bright Data proxy services, affiliate should follow this flow.
  1. Setup affiliate account with Bright Data
  2. For each end user: open user in Bright Data
  3. For each product sell: setup zone in Bright data (limit: 50 zones per user)
  4. Each zone will have its own access information set: proxy username and password.

​
Glossary

Important terminology needed to understand Bright Data’s /affiliate APIs.

​
Partner prefix

Two letters which Bright Data assigns to each partner. All user/account IDs will carry this prefix. In the examples here we used “tp_”.

​
User/Account ID

A unique identified of entity consuming Bright Data services. Each user of affiliate will get a unique Bright Data account ID starting with letter tp_ followed by random letters and number. Example: tp_fd821b5e

​
Zone

Under the account, zone represent a configuration set. A collection of product type, amount and other information impacting proxy behavior. Each zone has its own user and password combination, which are the PROXY user and password which the user needs to provide to access the zone’s proxy services.

​
Superproxy

The listener process on Bright Data side which accepts the initial proxy request, and establishes the tunnel to the peer. The superproxy get the request and relays it to the peer.

​
Peer

The actual node identified by the Proxy IP address, which relays the request to the target.

​
Username

The proxy username represented as long hash for security reasons.

​
Examples

In this examples Partner name will be example and DNS url example.proxy.comStep 1: Create user on brightdata side:
Response:
The user/account id tp_fd821b5e and new zone name shared_static_res.User ID or Account ID is equivalent to a affiliate user. Each user ID (like “account”) can setup multiple proxy products on Bright Data side (“proxy zones”), each with its own set of configuration and access (proxy user/password).Step 2: Create proxy username to access Bright Data proxy service (superproxy)
Note request query params, we provide new user id and zone name.Response:
Response format is
[PROXY_URL:PROXY_PORT:PROXY_USERNAME:PROXY_PASSWORD]Step 3: Test the proxy zone
Step 4: Control the usage limit.By default users are created with 1KB limit. To extend it:
Response:
Step 5: Create another zone for the same user of dedicated_dc type, name new_dc and 2 ips allocated
Response:
Step 6: Check allocated ips for new zone
Response:
Step 7: Create proxy username for accessing new zone for each ipBy default - we will rotate around the IPs in the zone. To target specific IP, I would need to generate a user/password set per each IP.To generate it:
Response:
In response first array element is proxy credentials using ip 152.39.152.207 second is for 168.151.126.63Note: port number may range from 31111 to 31114 ; for load balancing purposes.
  1. Allocate IPs
  2. Change Zone Usage Limit
  3. Create or Change Usage Webhook Settings
  4. Disable Customer
  5. Enable Customer
  6. Generate Proxy Username
  7. Generate Socks 5 Proxy Username
  8. Get All Available ASNs
  9. Get Allocated IPs for a Zone
  10. Get Amount of Shared ISP IPs by Countries
  11. Get Available Carriers
  12. Get Available Countries
  13. Get Customers
  14. Get IPs Amount by Carrier
  15. Get Usage Webhook Info
  16. Get Zone Usage Limit
  17. Get Zone Usage Limit Stats
  18. Refresh IPs
  19. Remove Allocated IPs
  20. Sign up Customer in Dedicated DC Zone
  21. Sign up Customer in Dedicated ISP Zone
  22. Sign up Customer in Residential Zone
  23. Sign up Customer in Shared DC Zone
  24. Sign up Customer in Smart Residential Zone
  25. Sign up Customer with Shared ISP IPs