OpenAPI

app_key Ключ аутентификации можно посмотреть на главной странице личного кабинета после входа в систему.

Пожалуйста, надежно храните ключ, ключ предоставляет права администратора вашей учетной записи.

Базовые URL-адреса:

Аутентификация

Управление прокси-аккаунтами

GET Список прокси-аккаунтов

GET /openapi/whitelist-account/list

Пример возврата

Ответ 200

{
	"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

Имя	Тип	Обязательный	Ограничение	Описание
» код	responseCode	false	отсутствует	Код состояния, 200 успешно, 3 app_key недействителен
» msg	строка	false	отсутствует	Сообщение о состоянии
» данные	объект	ложь	ничего	ничего
»» список	[объект]	ложь	ни один	никто
»»» id	целое число	ложь	нет	Номер счета
»»» имя пользователя	строка	ложь	отсутствует	Имя учетной записи прокси
»»» пароль	строка	ложь	отсутствует	Пароль учетной записи прокси
»»» created_at	строка	false	нет	Время добавления
»»» замечание	строка	ложь	нет	Примечания
»»» product_type	productTypes	false	none	Тип пакета, 9 Динамический домашний трафик, 11 Динамический домашний IP, 14 Статический IP дата-центра, 25 Статический домашний IP
»»» usage_flow	целое число	ложь	отсутствует	Использованный трафик, единица измерения: КБ
»»» ограничение_потока	целое число	ложь	отсутствует	Настраиваемый лимит трафика: единица измерения ГБ, максимум 102400, 0 означает отсутствие ограничений
»»» status	целое число	false	отсутствует	Статус включения: 1 - включено, 0 - отключено

Перечисляемые значения

Атрибут	Значение
Тип_продукта	9
Тип_продукта	11
Тип_продукта	14
product_type	25

POST Добавить прокси-аккаунт.

POST /openapi/whitelist-account/add

Параметры запроса в теле запроса

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

Параметры запроса

Имя	Расположение	Тип	Обязательно	Описание
тело	тело	объект	Нет	нет
» app_key	тело	строка	Нет	Авторизационный ключ
» аккаунты	тело	строка	Нет	Учетные данные, пожалуйста, введите в формате username:password. Имя пользователя и пароль должны содержать только цифры и буквы, без каких-либо специальных символов или пробелов. Разделите имя пользователя и пароль двоеточием. Поддерживается добавление нескольких учетных записей, разделенных английской запятой (,).
» remark (примечание)	body (тело)	string (строка)	Нет	Описание прокси-аккаунта
» product_type	тело	productTypes	Нет	Тип пакета, 9 Динамический домашний трафик, 11 Динамический домашний IP, 14 Статический IP-адрес дата-центра, 25 Статический домашний IP

Перечисляемое значение

Атрибут	Значение
» product_type	9
» product_type	11
» Тип_продукта	14
» Тип_продукта	25

Пример ответа

200 Response

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

Результат возврата

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Структура возвращаемых данных

Код состояния **200**

Имя	Тип	Обязательный	Ограничения	Описание
» code	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» сообщение	строка	ложь	отсутствует	Статус сообщения
» data	null	false	нет	нет

POST Удалить прокси-аккаунт

POST /openapi/whitelist-account/delete

Обратите внимание, что удаление необратимо, и использованный трафик и т. д. невозможно запросить. Удаление занимает около 5 минут, в течение которых может взиматься плата.

Параметры запроса Body

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

Параметры запроса

Имя	Позиция	Тип	Обязательный	Описание
тело	тело	объект	Нет	никто
» app_key	тело	строка	Нет	Авторизационный ключ
» аккаунты	тело	строка	Нет	Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделенные английской запятой (,) прокси-аккаунты

Пример возврата

200 Ответ

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

Возвращаемый результат

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничение	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	ложь	нет	Сообщение о состоянии
» данные	null	false	none	none

POST: прокси-аккаунты отключены

POST /openapi/whitelist-account/disable

Отключение занимает около 5 минут, в течение этого времени все еще могут взиматься сборы.

Параметры тела запроса

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

Параметры запроса

Название	Позиция	Тип	Обязательный	Описание
тело	тело	объект	Нет	отсутствует
» app_key	тело	строка	Нет	Авторизационный ключ
» accounts	тело	строка	Нет	Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделенные английскими запятыми (,) прокси-аккаунты.

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состояния	Код состояния, значение	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	отсутствует	Сообщение о состоянии
» данные	null	false	none	none

POST Активировать прокси-аккаунт

POST /openapi/whitelist-account/enable

Параметры тела запроса

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

Параметры запроса

Название	Позиция	Тип	Обязательный	Описание
тело	тело	объект	Нет	отсутствует
» app_key	тело	строка	Нет	Авторизационный ключ
» accounts	тело	строка	Нет	Прокси-аккаунт, поддерживает только цифры и буквы. Поддерживает пакетные операции, разделенные английскими запятыми (,) прокси-аккаунты.

Пример возврата

Ответ 200

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

Результат возврата

Код состояния	Код состояния, значение	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	нет	Сообщение о состоянии
» данные	null	false	none	none

POST Изменить пароль прокси-аккаунта

POST /openapi/whitelist-account/change-password

Обратите внимание, что после изменения необходимо подождать 5 минут, в течение которых старый пароль все еще может быть использован.

Параметры запроса Body

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

Параметры запроса

Имя	Расположение	Тип	Обязательно	Описание
тело	тело	объект	Нет	отсутствует
» app_key	тело	строка	Нет	Ключ авторизации
» аккаунт	тело	строка	Нет	Прокси-аккаунт, поддерживает только цифры и буквы.
» пароль	тело	строка	Нет	Новый пароль для учетной записи агента, поддерживает только цифры и буквы.

Пример ответа

200 Ответ

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

Результат возврата

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	пусто	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» сообщение	строка	ложь	отсутствует	Статус сообщения
» data	null	false	никто	никто

POST Изменить примечание к прокси-аккаунту

POST /openapi/whitelist-account/change-remark

Параметры тела запроса

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

Параметры запроса

Имя	Расположение	Тип	Обязательный	Описание
body	body	объект	Нет	нет
» app_key	тело	строка	Нет	Авторизационный ключ
» учетная запись	тело	строка	Нет	Учетная запись агента, поддерживаются только цифры и буквы.
» Примечание	Тело	Строка	Нет	Новая заметка для прокси-аккаунта, не более 32 китайских символов или 64 английских.

Пример ответа

Ответ 200

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

Результат возврата

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	Запрос выполнен	Встроенный

Возвращаемая структура данных

Код состояния 200

Название	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	нет	Сообщение о состоянии
» данные	null	false	none	none

POST Изменить лимит трафика для прокси-аккаунта

POST /openapi/whitelist-account/change-limit

Обратите внимание, что статистика трафика может задерживаться до 5 минут, то есть фактическое потребление трафика может превысить этот лимит.

Параметры тела запроса

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

Параметры запроса

Имя	Позиция	Тип	Обязательный	Описание
body	body	объект	Нет	нет
» app_key	тело	строка	Нет	Авторизационный ключ
» учетная запись	тело	строка	Нет	Агентский аккаунт, поддерживает только цифры и буквы.
» limit	body	integer	Нет	Ограничение трафика, единица измерения: ГБ, 0 означает отсутствие ограничений

Пример ответа

200 Ответ

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

Возвращаемый результат

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничение	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	нет	Сообщение о состоянии
» данные	null	ложь	никто	никто

Поиск логов трафика

GET Использование трафика суммируется по дням

GET /openapi/user-usage-flow/total

Параметры запроса

Имя	Местоположение	Тип	Обязательный	Описание
app_key	запрос	строка (пароль)	Да	Ключ аутентификации
start_time	query	строка(Y-m-d H:i:s)	Нет	Время начала, с точностью до секунды. Обратите внимание, что записи в журнале задерживаются не более чем на 5 минут. По умолчанию не более 7 дней.
end_time	query	string(ГГГГ-ММ-ДД ЧЧ:мм:сс)	Нет	Крайний срок, с точностью до секунды. Обратите внимание, что существует задержка в записи логов до 5 минут. По умолчанию - текущее время.
username	query	строка	Нет	Имя субсчета, по умолчанию запрашиваются все счета, можно указать субсчет. Обратите внимание: если вы добавили субсчета с одинаковыми именами, этот запрос вернет все записи об использовании для агентских счетов с одинаковыми именами.
product_type	запрос	номер	Нет	Тип пакета

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состояния	Код состояния, значение	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	отсутствует	Сообщение о состоянии
» данные	объект	ложь	ничего	ничего
»» список	[объект]	ложь	ни один	никто
»»» день	строка	ложь	нет	Дата
»»» поток	целое число	false	none	Потребление трафика, в КБ

Поиск пакета

GET Список приобретенных пакетов

GET /openapi/user-product/list

Параметры запроса

Имя	Местоположение	Тип	Обязательный	Описание
app_key	запрос	строка (пароль)	Да	Ключ аутентификации
Номер транзакции	Запрос	Строка	Нет	Номер заказа, пожалуйста, введите полный номер заказа. Поиск по частичному совпадению не поддерживается.
страница	запрос	номер	Нет	Разбиение на страницы, по умолчанию: 1
size	query	количество	Нет	Количество элементов на странице, по умолчанию: 20
product_type	запрос	номер	Нет	Тип пакета

Пример возврата

Ответ 200

{
	"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

Имя	Тип	Обязательный	Ограничение	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	ложь	нет	Сообщение о состоянии
» данные	объект	ложь	отсутствует	отсутствует
»» список	[объект]	ложь	отсутствует	отсутствует
»»» id	целое число	ложь	отсутствует	Номер пакета
»»» created_at	строка	ложь	нет	Время активации пакета
»»» expired_at	строка	false	none	Срок действия пакета истек, после истечения срока действия трафик нельзя использовать.
»»» product_type	productTypes	false	none	Тип пакета, 9 Динамический трафик для дома, 11 Динамический IP для дома, 14 Статический IP для дата-центра, 25 Статический IP для дома
»»» trade_no	строка	false	нет	Транзакционный номер заказа
»»» order	объект	ложь	отсутствует	отсутствует
»»»» created_at	строка	false	none	Время создания заказа
»»»» pay_at	строка	ложь	отсутствует	Время оплаты заказа
»»»» заголовок	строка	ложь	отсутствует	Описание заказа
»» страница	целое число	ложь	отсутствует	Текущая страница
»» page_size	целое число	ложь	отсутствует	Размер страницы
»» total_count	целое число	ложь	отсутствует	Общее количество записей
»» Общее количество страниц	целое число	ложь	отсутствует	Общее количество страниц

Перечислимые значения

Атрибут	Значение
Тип_продукта	9
Тип_продукта	11
Тип_продукта	14
Тип_продукта	25

Извлечение IP

GET извлечение IP

GET /openapi/ip/v3

Параметры запроса

Имя	Позиция	Тип	Обязательный	Описание
app_key	query	string(пароль)	Нет	Ключ доступа
cc	запрос	строка	Нет	Страна или регион
штат	запрос	строка	Нет	Область или штат
город	запрос	строка	Нет	Город
формат	запрос	строка	Нет	Получение формата
lb	query	string	Нет	Разделитель, действителен только для формата text
кол-во	запрос	номер	Нет	Извлечь количество
жизнь	запрос	число	Нет	Длительность хранения - минуты
эп	запрос	строка	Нет	Прокси-сеть

Пример ответа

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

Название	Тип	Обязательный	Ограничения	Описание
» код	целое число	false	none	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	ложь	отсутствует	Сообщение о состоянии
» данные	объект	ложь	отсутствует	никто
»» список	[любой]	ложь	никто	никто

GET Список городов

GET /openapi/ip/dynamic-citys

Пример возврата

Ответ 200

{
	"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

Имя	Тип	Обязательный	Ограничение	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	нет	Сообщение о состоянии
» данные	объект	ложь	ничего	ничего
»» список	[объект]	ложь	ни один	Список
»»» name_zh_cn	строка	ложь	отсутствует	Название страны или региона
»»» name_en	строка	false	none	Название страны или региона
»»» continent_code	строка	ложь	отсутствует	Код континента
»»» код_страны	строка	ложь	отсутствует	Код страны или региона
»»» элементы	[объект]	ложь	нет	Область или штат
»»»» город	строка	false	none	Название города
»»»» область	строка	ложь	отсутствует	Код названия штата или провинции
»»»» код континента	строка	ложь	отсутствует	Код континента
»»»» country_code	строка	false	отсутствует	Код страны или региона

GET Поиск города

GET /openapi/ip/dynamic-citys/search

Параметры запроса

Имя	Расположение	Тип	Обязательно	Описание
country_code	query	строка	является	Код страны или региона
штат	запрос	строка	да	Код штата или провинции

Пример возврата

Ответ 200

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

Возвращаемый результат

Код состояния	Код состояния, значение	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	отсутствует	Сообщение о состоянии
» данные	объект	ложь	ничего	ничего
»» список	[строка]	ложь	никто	Список

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 – учетная запись не прошла проверку подлинности
» сообщение	строка	ложь	отсутствует	Сообщение о состоянии
» data	объект	false	никто	никто
»» список	[объект]	ложный	отсутствует	список
»»» name_zh_cn	строка	ложь	отсутствует	Название страны или региона
»»» name_ru	строка	ложь	отсутствует	Название страны или региона
»»» continent_code	string	false	никто	Код континента
»»» код_страны	строка	false	нет	Код страны или региона
»»» элементы	[объект]	ложь	отсутствует	Область или штат
»»»» состояние	строка	ложь	отсутствует	Код названия штата или провинции
»»»» continent_code	строка	false	отсутствует	Код континента
»»»» country_code	строка	false	нет	Код страны или региона

GET Поиск штата/провинции

GET /openapi/ip/dynamic-states/search

Параметры запроса

Имя	Местоположение	Тип	Обязательный	Описание
country_code	запрос	строка	да	Код страны или региона

Пример возврата

Ответ 200

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

Результат возврата

Код состояния	Код состояния, значение	Описание	Модель данных
200	OK	Успешный запрос	Встроенный

Возвращаемая структура данных

Код состояния 200

Имя	Тип	Обязательный	Ограничения	Описание
» код	целое число	ложь	отсутствует	Код состояния: 200 – успешно, 3 – недействительный app_key, 156 – учетная запись не прошла проверку подлинности
» msg	строка	false	отсутствует	Сообщение о состоянии
» данные	объект	ложь	ничего	ничего
»» список	[строка]	ложь	нет	Список

GET Получение списка статических IP-адресов

GET /ip/get-static-ip

Параметры запроса

Название	Позиция	Тип	Обязательный	Описание
код_страны	запрос	строка	Нет	Код страны или региона
Тип продукта	Запрос	номер	Нет	Тип продукта, 25: Статический резидентный IP, 14: IP-адрес дата-центра
trade_no	запрос	строка	Нет	Фильтровать IP по номеру заказа
страница	запрос	номер	Нет	Страница
Размер	Запрос	Номер	Нет	Количество на странице
статус	запрос	Номер	Нет	Статус: 1 — действителен, 2 — недействителен, 3 — скоро истечет, 4 — на обслуживании

Перечисляемое значение

Атрибут	Значение
product_type	14
product_type	25
статус	1
статус	2
статус	3
статус	4

Пример возврата

Ответ 200

{}

Возвращаемый результат

Код состояния	Значение кода состояния	Описание	Модель данных
200	OK	нет	Встроенный

Возвращаемая структура данных

Модель данных

productTypes

Тип пакета, 9 Динамический пакет трафика для дома, 11 Динамический IP-адрес для дома, 14 Статический IP-адрес для дата-центра, 25 Статический IP-адрес для дома

Атрибут

Имя	Тип	Обязательный	Ограничения	Китайское название	Описание
анонимный	целое число	false	none		Тип пакета, 9 Динамический домашний трафик, 11 Динамический домашний IP, 14 Статический IP дата-центра, 25 Статический домашний IP

Перечисляемое значение

Атрибут	Значение
анонимный	9
анонимный	11
анонимный	14
анонимный	25

apiKey

null

Ключ API

Имя	Тип	Обязательный	Ограничение	Китайское название	Описание
anonymous	целое число	ложь	отсутствует		Код состояния: 200 – успешно, 3 – недействительный app_key

Сообщение ответа

"success"

сообщение ответа

Атрибут

Имя	Тип	Обязательный	Ограничение	Китайское название	Описание
anonymous	string	false	отсутствует		ответное сообщение