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

# API 白名单

<Tip>平台的所有代理产品均需要在海外网络环境下使用，海外网络环境需要客户自行配置。</Tip>

本文将介绍如何在 **Ip2up平台** 为动态住宅代理配置 **API 白名单**，以便通过 API 接口安全地获取代理信息。

### 一、选择白名单

登录 **Ip2up** 平台后，点击左侧菜单栏的 **动态住宅代理**，然后在界面中选择 **白名单** 选项。

<img src="https://mintcdn.com/acme-2c62d9fa/QOpXZuMzSaiDyAWQ/res/images/new6.png?fit=max&auto=format&n=QOpXZuMzSaiDyAWQ&q=85&s=4655a7f19dcfb95a8fc806d82c782793" alt="白名单管理入口" width="1920" height="1030" data-path="res/images/new6.png" />

### 二、管理白名单

**1. 添加白名单**

点击 **添加到白名单** 按钮，系统将自动将您当前的公网 IP 添加至白名单。

**2. 删除白名单 IP**

在白名单列表中，找到需要删除的 IP 地址，点击右侧的 **删除** 按钮即可移除。

<img src="https://mintcdn.com/acme-2c62d9fa/QOpXZuMzSaiDyAWQ/res/images/new7.png?fit=max&auto=format&n=QOpXZuMzSaiDyAWQ&q=85&s=f4fa3497e0b7be1c635bf2af64c8389d" alt="白名单添加与删除界面" width="1920" height="1030" data-path="res/images/new7.png" />

**3. 批量添加白名单**

如需手动添加多个 IP 地址：

* 在输入框中填写 IP 地址（每行一个）
* 可选填备注信息，便于识别和管理
* 单击 **确定** 按钮完成添加

<img src="https://mintcdn.com/acme-2c62d9fa/QOpXZuMzSaiDyAWQ/res/images/new8.png?fit=max&auto=format&n=QOpXZuMzSaiDyAWQ&q=85&s=ce48bfa38e1966bfdce7faf634ba762e" alt="批量添加 IP 界面" width="1920" height="1030" data-path="res/images/new8.png" />

### 三、配置代理参数

**API 参数说明**

|       参数      |   类型   |  必填 | 说明                                             |
| :-----------: | :----: | :-: | :--------------------------------------------- |
|     `mode`    | string |  是  | 会话类型：`rotating`（轮换 IP）、`sticky`（粘性 IP）         |
|     `host`    | string |  是  | 代理网关地址                                         |
|   `protocol`  | string |  是  | 代理协议：`http` 或 `socks5`                         |
|   `country`   | string |  否  | 国家代码，如 `US`（不填则随机）                             |
|    `state`    | string |  否  | 州/地区代码，如 `AK`（需配合 country 使用）                  |
|     `city`    | string |  否  | 城市名称，如 `Bethel`（需配合 country、state 使用）          |
|    `count`    |   int  |  是  | 生成代理数量，支持 **1 至 100**                          |
|    `format`   | string |  是  | 输出格式：`txt`（文本格式）、`json`（JSON 格式）               |
| `sessionTime` |   int  |  否  | 粘性 IP 持续时间（分钟），**1 至 70**，仅在 `mode=sticky` 时生效 |

**配置步骤**

**1. 选择地理位置**

* 选择指定的 **国家/地区**
* 或选择 **随机位置**，由系统自动分配

**2. 选择代理格式**

* **TXT**：文本格式
* **JSON**：JSON 格式

**3. 选择代理协议**

支持 **HTTP** 和 **SOCKS5** 两种代理协议，请根据实际使用场景选择。

**4. 选择代理地址**

系统将根据您的配置自动分配可用的代理网关地址。

**5. 配置会话类型**

* **轮换 IP** ：每个新请求自动更换 IP
* **粘性 IP** ：保持相同 IP，持续时长为 **1 至 70 分钟**

**6. 设置生成数量**

选择需要生成的代理数量，支持 **1 至 100** 之间的任意整数。

<img src="https://mintcdn.com/acme-2c62d9fa/xN0yDIHGM8aWGG6H/res/images/API4.png?fit=max&auto=format&n=xN0yDIHGM8aWGG6H&q=85&s=aa67d2a9db17efaaece92fd4375e4dcf" alt="代理参数配置界面" width="1054" height="474" data-path="res/images/API4.png" />

### 四、生成并获取代理信息

1. 点击 **生成代理** 按钮
2. 在右侧的 **代理信息** 区域，系统将根据以上配置显示生成的代理信息
3. 生成成功后，您可以：
   * 直接点击 **打开 URL**，在浏览器中查看生成的代理列表
   * 或点击 **复制 URL**，获取 API 链接以便程序调用

<img src="https://mintcdn.com/acme-2c62d9fa/fjdPsa29vFWJ9m28/res/images/API5.png?fit=max&auto=format&n=fjdPsa29vFWJ9m28&q=85&s=dc8ab1fd6006fed8b2236e6499a33768" alt="代理信息生成与获取界面" width="1575" height="761" data-path="res/images/API5.png" />

✅ **至此，已成功配置动态住宅代理的 API 白名单，并可通过 API 链接获取代理信息。**