> ## 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 白名單
平台的所有代理產品均需要在海外網路環境下使用，海外網路環境需要客戶自行配置。
本文將介紹如何在 **Ip2up平台** 為動態住宅代理配置 **API 白名單**，以便透過 API 介面安全地獲取代理資訊。
### 一、選擇白名單
登入 **Ip2up** 平台後，點擊左側選單列的 **動態住宅代理**，然後在介面中選擇 **白名單** 選項。
### 二、管理白名單
**1. 新增白名單**
點擊 **新增至白名單** 按鈕，系統將自動將您當前的公網 IP 新增至白名單。
**2. 刪除白名單 IP**
在白名單列表中，找到需要刪除的 IP 位址，點擊右側的 **刪除** 按鈕即可移除。
**3. 批量新增白名單**
如需手動新增多個 IP 位址：
* 在輸入框中填寫 IP 位址（每行一個）
* 可選填備註資訊，便於識別和管理
* 單擊 **確定** 按鈕完成新增
### 三、配置代理參數
**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** 之間的任意整數。
### 四、生成並獲取代理資訊
1. 點擊 **生成代理** 按鈕
2. 在右側的 **代理資訊** 區域，系統將根據以上配置顯示生成的代理資訊
3. 生成成功後，您可以：
* 直接點擊 **開啟 URL**，在瀏覽器中查看生成的代理列表
* 或點擊 **複製 URL**，獲取 API 連結以便程式呼叫
✅ **至此，已成功配置動態住宅代理的 API 白名單，並可透過 API 連結獲取代理資訊。**