OpenAPI

app_key 認證金鑰請登入後在個人中心首頁查看。

請安全保存金鑰，金鑰擁有您的帳戶管理員權限。

Base URLs:

身份驗證

代理帳戶管理

GET 代理帳戶列表

GET /openapi/whitelist-account/list

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"username": "string",
				"password": "string",
				"created_at": "string",
				"remark": "string",
				"product_type": 9,
				"usage_flow": 0,
				"limit_flow": 102400,
				"status": 0
			}
		]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	responseCode	錯誤	無	狀態碼，200 成功、3 app_key 無效
» 訊息	字串	錯誤	無	狀態訊息
» data	物件	錯誤	無	無
»» list	[物件]	錯誤	無	無
»»» id	整數	錯誤	無	帳戶編號
»»» username	字串	錯誤	無	代理帳戶名
»»» password	字串	錯誤	無	代理帳戶密碼
»»» created_at	字串	錯誤	無	新增時間
»»» remark	字串	錯誤	無	備註
»»» product_type	productTypes	錯誤	無	套餐類型，9 動態住宅流量套餐、11 動態住宅 IP、14 靜態數據中心 IP、25 靜態住宅 IP
»»» usage_flow	整數	錯誤	無	已使用流量，單位：KB
»»» limit_flow	整數	錯誤	無	自訂流量上限：單位 GB 最大 102400，0 不限制
»»» 狀態	整數	錯誤	無	啟用狀態：1 啟用，0 停用

枚舉值

屬性	值
product_type	9
product_type	11
product_type	14
product_type	25

POST 新增代理帳戶。

POST /openapi/whitelist-account/add

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01:pass,user02:pass,user03:pass",
	"remark": "",
	"product_type": 9
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» accounts	內文	字串	否	帳戶密碼，請按格式 username:password 填寫，帳戶和密碼僅支援數字和字母，禁止輸入任何特殊符號或空格，冒號隔開帳戶和密碼。支援批量新增，英文逗號（,）分隔代理帳戶。
» remark	內文	字串	否	代理帳戶描述
» product_type	內文	productTypes	否	套餐類型，9 動態住宅流量套餐、11 動態住宅 IP、14 靜態數據中心 IP、25 靜態住宅 IP

枚舉值

屬性	值
» product_type	9
» product_type	11
» product_type	14
» product_type	25

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» data	空值	錯誤	無	無

POST 刪除代理帳戶

POST /openapi/whitelist-account/delete

請注意刪除後無法恢復，已使用流量等無法查詢。刪除約有 5 分鐘等待時間，在此期間仍可能產生費用。

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» accounts	內文	字串	否	代理帳戶，僅支援數字和字母。支援批量操作，英文逗號（,）分隔代理帳戶

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	空值	錯誤	無	無

POST 禁用代理帳戶

POST /openapi/whitelist-account/disable

禁用約有 5 分鐘等待時間，在此期間仍可能產生費用。

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» accounts	內文	字串	否	代理帳戶，僅支援數字和字母。支援批量操作，英文逗號（,）分隔代理帳戶

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	空值	錯誤	無	無

POST 啟用代理帳戶

POST /openapi/whitelist-account/enable

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"accounts": "user01,user02"
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» accounts	內文	字串	否	代理帳戶，僅支援數字和字母。支援批量操作，英文逗號（,）分隔代理帳戶

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» data	空值	錯誤	無	無

POST 修改代理帳戶密碼

POST /openapi/whitelist-account/change-password

請注意修改後有 5 分鐘等待時間，在此期間舊密碼仍可能正常使用。

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"password": "pass"
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» 帳戶	內文	字串	否	代理帳號，僅支援數字和字母。
» password	內文	字串	否	代理帳戶新密碼，僅支援數字和字母。

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	空值	錯誤	無	無

POST 修改代理帳戶備註

POST /openapi/whitelist-account/change-remark

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"remark": ""
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» 帳戶	內文	字串	否	代理帳號，僅支援數字和字母。
» remark	內文	字串	否	代理帳號新備註，32 個中文字或 64 個英文字以內。

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	空值	錯誤	無	無

POST 修改代理帳戶流量上限

POST /openapi/whitelist-account/change-limit

請注意流量統計可能有 5 分鐘以內延遲，即實際消耗流量可能超過此限制。

Body 請求參數

{
	"app_key": "stringstringstringstringstringst",
	"account": "user",
	"limit": 0
}

請求參數

名稱	位置	類型	必選	說明
內文	內文	物件	否	無
» app_key	內文	字串	否	授權金鑰
» 帳戶	內文	字串	否	代理帳號，僅支援數字和字母。
» limit	內文	整數	否	流量限制，單位：GB，0 為不設上限

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": null
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	空值	錯誤	無	無

流量日誌查詢

GET 使用流量按天彙總

GET /openapi/user-usage-flow/total

請求參數

名稱	位置	類型	必選	說明
app_key	query	字串(password)	是	認證金鑰
start_time	query	字串(Y-m-d H:i:s)	否	起始時間，可精確到秒。請注意，日誌記錄有 5 分鐘以內延遲。預設 7 天以內。
end_time	query	字串(Y-m-d H:i:s)	否	截止時間，可精確到秒。請注意，日誌記錄有 5 分鐘以內延遲。預設目前時間。
使用者名稱	query	字串	否	子帳戶名稱，預設查詢所有帳戶，可指定子帳戶。請注意如果您添加了相同名稱的子帳戶，此查詢將返回同名代理帳戶的所有使用記錄。
product_type	query	number	否	方案類型

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"day": "2022-08-01",
				"flow": 0
			}
		]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	物件	錯誤	無	無
»» 清單	[物件]	錯誤	無	無
»»» day	字串	錯誤	無	日期
»»» 流程	整數	錯誤	無	消耗流量，單位 KB

方案查詢

GET 已購套餐列表

GET /openapi/user-product/list

請求參數

名稱	位置	類型	必選	說明
app_key	query	字串(password)	是	認證金鑰
trade_no	query	字串	否	訂單號，請輸入完整訂單號。不支援模糊搜尋。
頁面	query	number	否	分頁，預設：1
大小	query	number	否	分頁顯示數量，預設：20
product_type	query	number	否	方案類型

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"id": 0,
				"created_at": "2022-05-13 12:14:15",
				"expired_at": "2022-05-13 12:14:15",
				"product_type": 9,
				"trade_no": "2022051312134339861461465434",
				"order": {
					"created_at": "2022-05-13 12:13:43",
					"pay_at": "2022-05-13 12:13:43",
					"title": "入门级"
				}
			}
		],
		"page": 1,
		"page_size": 20,
		"total_count": 0,
		"total_page": 0
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

返回資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» data	物件	錯誤	無	無
»» 清單	[物件]	錯誤	無	無
»»» id	整數	錯誤	無	套餐編號
»»» created_at	字串	錯誤	無	方案生效時間
»»» expired_at	字串	錯誤	無	套餐過期時間，過期後流量無法使用。
»»» product_type	productTypes	錯誤	無	套餐類型，9 動態住宅流量套餐、11 動態住宅 IP、14 靜態數據中心 IP、25 靜態住宅 IP
»»» trade_no	字串	錯誤	無	訂單交易號
»»» order	物件	錯誤	無	無
»»»» created_at	字串	錯誤	無	訂單建立時間
»»»» pay_at	字串	錯誤	無	訂單支付時間
»»»» title	字串	錯誤	無	訂單描述
»» page	整數	錯誤	無	目前分頁
»» page_size	整數	錯誤	無	分頁大小
»» total_count	整數	錯誤	無	總記錄數量
»» total_page	整數	錯誤	無	總分頁數量

枚舉值

屬性	值
product_type	9
product_type	11
product_type	14
product_type	25

IP 提取

GET 提取 IP

GET /openapi/ip/v3

請求參數

名稱	位置	類型	必選	說明
app_key	query	字串(password)	否	存取金鑰
cc	query	字串	否	國家或地區
state	query	字串	否	省或州
城市	query	字串	否	城市
格式	query	字串	否	取得格式
磅	query	字串	否	間隔符，僅 text 格式有效
數字	query	number	否	提取數量
生活	query	number	否	保持週期-分鐘
情節	query	字串	否	代理網路

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			[
				"150.109.114.72:1140",
				"150.109.114.72:1141",
				"150.109.114.72:1142",
				"150.109.114.72:1143",
				"150.109.114.72:1144",
				"150.109.114.72:1145",
				"150.109.114.72:1146",
				"150.109.114.72:1147",
				"150.109.114.72:1148",
				"150.109.114.72:1149"
			]
		]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 數據	物件	錯誤	無	無
»» 列表	[任意]	錯誤	無	無

GET 城市列表

GET /openapi/ip/dynamic-citys

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"city": null,
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	物件	錯誤	無	無
»» 列表	[物件]	錯誤	無	清單
»»» 中文名稱	字串	錯誤	無	國家或地區名稱
»»» 英文名稱	字串	錯誤	無	國家或地區名稱
»»» continent_code	字串	錯誤	無	洲代碼
»»» country_code	字串	錯誤	無	國家或地區代碼
»»» 項目	[物件]	錯誤	無	省或州
»»»» 城市	字串	錯誤	無	城市名稱
»»»» 州	字串	錯誤	無	省或州名稱代碼
»»»» continent_code	字串	錯誤	無	洲代碼
»»»» country_code	字串	錯誤	無	國家或地區代碼

GET 城市搜尋

GET /openapi/ip/dynamic-citys/search

請求參數

名稱	位置	類型	必選	說明
country_code	query	字串	是	國家或地區代碼
state	query	字串	是	州或省代碼

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	物件	錯誤	無	無
»» 清單	[字串]	錯誤	無	清單

GET 州清單

GET /openapi/ip/dynamic-states

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": [
			{
				"name_zh_cn": "美国",
				"name_en": "United States",
				"continent_code": "NA",
				"country_code": "US",
				"items": [
					{
						"state": null,
						"continent_code": null,
						"country_code": null
					}
				]
			}
		]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» 資料	物件	錯誤	無	無
»» 列表	[物件]	錯誤	無	清單
»»» 中文名稱	字串	錯誤	無	國家或地區名稱
»»» 英文名稱	字串	錯誤	無	國家或地區名稱
»»» continent_code	字串	錯誤	無	洲代碼
»»» country_code	字串	錯誤	無	國家或地區代碼
»»» 項目	[物件]	錯誤	無	省或州
»»»» 州	字串	錯誤	無	省或州名稱代碼
»»»» continent_code	字串	錯誤	無	洲代碼
»»»» country_code	字串	錯誤	無	國家或地區代碼

GET 州/省搜尋

GET /openapi/ip/dynamic-states/search

請求參數

名稱	位置	類型	必選	說明
country_code	query	字串	是	國家或地區代碼

返回範例

200 Response

{
	"code": 200,
	"msg": "string",
	"data": {
		"list": ["string"]
	}
}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	請求成功	內聯

回傳資料結構

狀態碼 200

名稱	類型	必選	約束	說明
» code	整數	錯誤	無	狀態碼，200 成功、3 app_key 無效、156 帳戶未實名認證
» 訊息	字串	錯誤	無	狀態訊息
» data	物件	錯誤	無	無
»» list	[字串]	錯誤	none	列表

GET 獲取靜態 IP 列表

GET /ip/get-static-ip

請求參數

名稱	位置	類型	必選	說明
country_code	query	字串	否	國家或地區代碼
product_type	query	number	否	產品類型, 25:靜態住宅 IP, 14: 數據中心 IP
trade_no	query	字串	否	通過訂單號篩選 IP
頁面	query	number	否	頁碼
大小	query	number	否	每頁數量
狀態	query	number	否	狀態, 1:有效, 2:無效, 3:即將過期, 4:維護中

枚舉值

屬性	值
product_type	14
product_type	25
狀態	1
狀態	2
狀態	3
狀態	4

返回範例

200 Response

{}

傳回結果

狀態碼	狀態碼含義	說明	資料模型
200	OK	無	內聯

回傳資料結構

資料模型

productTypes

套餐類型，9 動態住宅流量套餐、11 動態住宅 IP、14 靜態數據中心 IP、25 靜態住宅 IP

屬性

名稱	類型	必選	約束	中文名	說明
匿名	整數	錯誤	無		套餐類型，9 動態住宅流量套餐、11 動態住宅 IP、14 靜態數據中心 IP、25 靜態住宅 IP

枚舉值

屬性	值
匿名	9
匿名	11
匿名	14
匿名	25

apiKey

null

驗證金鑰

屬性

無

responseCode

狀態碼，200 成功、3 app_key 無效

屬性

名稱	類型	必選	約束	中文名	說明
匿名	整數	錯誤	無		狀態碼，200 成功、3 app_key 無效

responseMsg

"success"

response message

屬性

名稱	類型	必選	約束	中文名	說明
匿名	字串	錯誤	無		回應訊息