> ## Documentation Index
> Fetch the complete documentation index at: https://docs.brightdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bright Data - 联盟 API 参考

<Accordion title="联盟 API 最佳实践">
  ## 初始设置

  我们需要从销售/合作伙伴获取以下信息：

  1. 合作伙伴名称：仅限字母
  2. 他们希望使用的 DNS URL。该 DNS 名称应指向：brd.superproxy.io。
  3. 授权 IP，用于添加到我们的白名单。其他 IP 将被阻止调用我们的联盟 API。
  4. 从以下列表中选择要转售的产品：

  | 代理类型 | 产品类型 | 所需信息             |
  | :--- | :--- | :--------------- |
  | 数据中心 | 旋转池  | 池大小、国家、每个国家的代理数量 |
  |      | 无限共享 | 国家列表、每个国家的 IP 数量 |
  |      | 无限专用 | 国家列表、每个国家的 IP 数量 |
  | ISP  | 旋转池  | 池大小、国家、每个国家的代理数量 |
  |      | 无限共享 | 国家列表、每个国家的 IP 数量 |
  |      | 无限专用 | 国家列表、每个国家的 IP 数量 |

  ## 高级联盟流程

  为提供 Bright Data 代理服务，联盟应遵循以下流程：

  1. 在 Bright Data 设置联盟账户
  2. 对每个最终用户：在 Bright Data 中开通用户
  3. 对每个销售的产品：在 Bright Data 中设置区域（限制：每个用户最多 50 个区域）
  4. 每个区域将有自己的访问信息集：代理用户名和密码。

  ## 术语表

  了解 Bright Data 的 /affiliate API 所需的重要术语。

  #### 合作伙伴前缀

  Bright Data 分配给每个合作伙伴的两个字母前缀。所有用户/账户 ID 都会携带此前缀。本示例中使用 "tp\_"。

  #### 用户/账户 ID

  消费 Bright Data 服务的实体的唯一标识。每个联盟用户将获得一个以 tp\_ 开头、后跟随机字母和数字的 Bright Data 账户 ID。例如：tp\_fd821b5e

  #### 区域

  在账户下，区域表示一个配置集。包含产品类型、数量及其他影响代理行为的信息。每个区域有自己的用户名和密码组合，即用户访问该区域代理服务所需的 PROXY 用户名和密码。

  #### Superproxy

  Bright Data 端的监听进程，接受初始代理请求，并建立到对等节点的隧道。Superproxy 接收请求并将其转发给对等节点。

  #### 对等节点

  由代理 IP 地址标识的实际节点，将请求转发到目标。

  #### 用户名

  为安全起见，代理用户名表示为长哈希。

  ## 示例

  在本示例中，合作伙伴名称为 example，DNS URL 为 example.proxy.com。

  **步骤 1：在 Bright Data 创建用户：**

  ```bash theme={null}
  curl -X POST "https://api.brightdata.com/example/signup_shared_isp"
  ```

  响应：

  ```json theme={null}
  {"id":"tp_fd821b5e","zone":"shared_static_res","password":"g6n62fj88zju","api_token":"aca02446-392c-4283-ab51-71fd25fcb9da"}
  ```

  用户/账户 ID 为 tp\_fd821b5e，新区域名称为 shared\_static\_res。

  用户 ID 或账户 ID 等同于一个联盟用户。每个用户 ID（如 "account"）可在 Bright Data 上设置多个代理产品（"代理区域"），每个产品都有自己的配置和访问信息（代理用户/密码）。

  **步骤 2：创建代理用户名以访问 Bright Data 代理服务（superproxy）**

  ```bash theme={null}
  curl -X GET "https://api.brightdata.com/example/proxies?id=tp_fd821b5e&zone=shared_static_res"
  ```

  注意请求查询参数，我们提供新的用户 ID 和区域名称。

  响应：

  ```json theme={null}
  ["example.proxy.com:31111:1a88cbd3954834b5050ae88acd14e9c48eb263207e742b87fedd41b3932b75525bec36774658924a6beaed9284635438:g6n62fj88zju"]
  ```

  响应格式为
  \[PROXY\_URL:PROXY\_PORT:PROXY\_USERNAME:PROXY\_PASSWORD]

  **步骤 3：测试代理区域**

  ```bash theme={null}
  curl --proxy example.proxy.com:31111 --proxy-user 1a88cbd3954834b5050ae88acd14e9c48eb263207e742b87fedd41b3932b75525bec36774658924a6beaed9284635438:g6n62fj88zju "http://brdtest.com/myip.json"
  ```

  **步骤 4：控制使用限制**

  默认情况下，用户创建时限额为 1KB。要扩展限额：

  ```bash theme={null}
  curl -X PUT "https://api.brightdata.com/example/usage_limit?id=tp_fd821b5e&zone=shared_static_res" -H "Content-Type: application/json" -d '{"limit": {"limit": 50000000}}'
  ```

  响应：

  ```json theme={null}
  {"unit":"bw","until":"2025-06-17T00:00:00.000Z","start":"2025-03-16T00:00:00.000Z","bust_action":"disable","limit":50000000,"zone":"shared_static_res"}
  ```

  **步骤 5：为同一用户创建另一个 dedicated\_dc 类型的区域，名称为 new\_dc，分配 2 个 IP**

  ```bash theme={null}
  curl -X PUT "https://api.brightdata.com/example/zone?id=tp_fd821b5e&type=dedicated_dc&ips_amount=2&zone=new_dc"
  ```

  响应：

  ```json theme={null}
  {"id":"tp_fd821b5e","zone":"new_dc","password":"w1625fn55f4c"}
  ```

  **步骤 6：检查新区域分配的 IP**

  ```bash theme={null}
  curl -X GET "https://api.brightdata.com/test_partner/ips?id=tp_fd821b5e&zone=new_dc"
  ```

  响应：

  ```json theme={null}
  {"ips":["152.39.152.207","168.151.126.63"]}
  ```

  **步骤 7：为每个 IP 创建访问新区域的代理用户名**

  默认情况下 - 我们将轮换区域内的 IP。若要针对特定 IP，需要为每个 IP 生成一组用户/密码。

  生成方法：

  ```bash theme={null}
  curl -X GET "https://api.brightdata.com/example/proxies?id=tp_fd821b5e&zone=new_dc2&ips=168.151.126.63,152.39.152.207"
  ```

  响应：

  ```json theme={null}
  [
  "example.proxy.com:31114:1a88cbd3954834b5050ae88acd14e9c4bd833ab19064869238b7c7213ae07b3e1b0bfb4e4f60f1b79ed72b1459c3091dba80251a30ee2773d9c848ccbe44fa50:u7yi034vn5ek",
  "example.proxy.com:31111:1a88cbd3954834b5050ae88acd14e9c4bd833ab19064869238b7c7213ae07b3e8cdc0f32beb2ad83fa9032e8ac0da4693de714f411fee1764be3a524f4771a68:u7yi034vn5ek"
  ]
  ```

  响应中，第一个数组元素使用 IP 152.39.152.207 的代理凭证，第二个为 168.151.126.63。

  注意：端口号可能从 31111 到 31114 不等，用于负载均衡。
</Accordion>

1. [分配 IP](/cn/api-reference/reseller-api/allocate-ips)
2. [更改区域使用限制](/cn/api-reference/reseller-api/usage-limit)
3. [创建或更改 Webhook 设置](/cn/api-reference/reseller-api/usage-webhook-settings)
4. [禁用客户](/cn/api-reference/reseller-api/disable-customer)
5. [启用客户](/cn/api-reference/reseller-api/enable-customer)
6. [生成代理用户名](/cn/api-reference/reseller-api/generate-proxy-username)
7. [生成 Socks 5 代理用户名](/cn/api-reference/reseller-api/generate-socks5-proxy-username)
8. [获取所有可用 ASN](/cn/api-reference/reseller-api/get-available-asn)
9. [获取某区域分配的 IP](/cn/api-reference/reseller-api/get-allocated-ips-for-zone)
10. [按国家获取共享 ISP IP 数量](/cn/api-reference/reseller-api/get-shared-isp-ips-by-country)
11. [获取可用的运营商](/cn/api-reference/reseller-api/get-available-carriers)
12. [获取可用国家](/cn/api-reference/reseller-api/get-available-countires)
13. [获取客户](/cn/api-reference/reseller-api/get-customers)
14. [按运营商获取 IP 数量](/cn/api-reference/reseller-api/get-ips-amount-by-carrier)
15. [获取使用情况 Webhook 信息](/cn/api-reference/reseller-api/get-usage-webhook-info)
16. [获取区域使用限制](/cn/api-reference/reseller-api/get-zone-usage-limit)
17. [获取区域使用限制统计](/cn/api-reference/reseller-api/get-zone-usage-limit-stats)
18. [刷新 IP](/cn/api-reference/reseller-api/refresh-ips)
19. [移除分配的 IP](/cn/api-reference/reseller-api/remove-allocated-ips)
20. [在 Dedicated DC 区域注册客户](/cn/api-reference/reseller-api/sign-up-customer-in-dedicated-dc)
21. [在 Dedicated ISP 区域注册客户](/cn/api-reference/reseller-api/sign-up-customer-in-dedicated-isp)
22. [在 Residential 区域注册客户](/cn/api-reference/reseller-api/sign-up-customer-in-residential-zone)
23. [在 Shared DC 区域注册客户](/cn/api-reference/reseller-api/sign-up-customer-in-shared-dc)
24. [在 Smart Residential 区域注册客户](/cn/api-reference/reseller-api/sign-up-customer-in-smart-residential-zone)
25. [使用共享 ISP IP 注册客户](/cn/api-reference/reseller-api/sign-up-customer-with-shared-isp-ips)
