res_proxy.php¶

Модуль управления резидентными прокси: управление конфигурациями (создание, удаление, обновление), получение списков городов и регионов, а также администрирование тарифных планов.

Методы API¶

Метод	Действие	Описание
`create_config`	создание конфигурации	Создает новую конфигурацию прокси.
`delete_config`	удаление конфигурации	Удаляет существующую конфигурацию прокси.
`get_cities`	получение городов	Возвращает список городов для указанной страны или региона.
`get_configs`	получение списка конфигураций	Возвращает список созданных пользователем конфигураций прокси.
`get_params`	получение параметров прокси	Возвращает доступные параметры конфигурации прокси для клиента.
`get_regions`	получение регионов	Возвращает список доступных регионов для указанной страны.
`regenerate_config`	перегенерация конфигурации	Перегенерирует сессии для существующей конфигурации.
`update_config`	обновление конфигурации прокси	Обновляет параметры существующей конфигурации резидентных прокси, включая название, страну, протокол и количество сессий.

res_proxy/get_params¶

Возвращает доступные параметры конфигурации прокси для клиента.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_params`
token	✅	string	Токен авторизации
show_by	✅	integer	Параметр группировки данных (например, по стране)
page	✅	integer	Номер страницы пагинации.

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=get_params" \
--data "token=HOSTKEY_TOKEN" \
--data "show_by=1" \
--data "page=1"

Пример успешного ответа

{
"result": "OK",
"action": "get_params",
"module": "res_proxy",
"params": [
{
"id": 1,
"name": "Example Proxy Set",
"status": "active",
"count": 50
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_empty_country"
}

res_proxy/get_configs¶

Возвращает список созданных пользователем конфигураций прокси.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_configs`
token	✅	string	Токен авторизации
show_by	✅	integer	Параметр группировки данных.
page	✅	integer	Номер страницы пагинации.

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=get_configs" \
--data "token=HOSTKEY_TOKEN" \
--data "show_by=1" \
--data "page=1"

Пример успешного ответа

{
"result": "OK",
"action": "get_configs",
"module": "res_proxy",
"config_data": [
{
"id": 10,
"name": "My Proxy Config",
"country": "US",
"protocol": "http",
"quantity": 50,
"created_at": "2024-05-20T12:00:00Z"
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_empty_country"
}

res_proxy/get_regions¶

Возвращает список доступных регионов для указанной страны.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_regions`
token	✅	string	Токен авторизации
country	✅	string	Код страны (например, US, NL).

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=get_regions" \
--data "token=HOSTKEY_TOKEN" \
--data "country=US"

Пример успешного ответа

{
"result": "OK",
"action": "get_regions",
"module": "res_proxy",
"locations": [
{
"code": "NY",
"name": "New York"
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_unknow_region"
}

res_proxy/get_cities¶

Возвращает список городов для указанной страны или региона.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_cities`
token	✅	string	Токен авторизации
country	❌	string	Код страны.
region	❌	string	Код региона.

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=get_cities" \
--data "token=HOSTKEY_TOKEN" \
--data "country=US"

Пример успешного ответа

{
"result": "OK",
"action": "get_cities",
"module": "res_proxy",
"cities": [
{
"id": 1,
"name": "Los Angeles",
"code": "LA"
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_empty_country"
}

res_proxy/create_config¶

Создает новую конфигурацию прокси.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_config`
token	✅	string	Токен авторизации
name	✅	string	Название конфигурации.
country	✅	string	Код страны.
protocol	✅	string	Протокол подключения.
count	✅	integer	Количество прокси. Допустимые значения: от 1 до 500.
config_type	✅	string	Тип конфигурации.
show_by	✅	integer	Параметр группировки для обновления списка после создания.
page	❌	integer	Номер страницы пагинации.
region	❌	string	Код региона (опционально).
city	❌	string	Код города (опционально).

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=create_config" \
--data "token=VALUE" \
--data "name=VALUE" \
--data "country=VALUE" \
--data "protocol=VALUE" \
--data "count=VALUE" \
--data "config_type=VALUE" \
--data "show_by=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "create_config",
"module": "res_proxy",
"data": [
{
"id": 1,
"name": "New Config",
"country": "US",
"protocol": "http",
"quantity": 10,
"config_type": "standard"
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_not_enough_parameters"
}

res_proxy/delete_config¶

Удаляет существующую конфигурацию прокси.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete_config`
token	✅	string	Токен авторизации
config_id	✅	integer	ID конфигурации для удаления.
show_by	❌	integer	Параметр группировки для обновления списка после удаления.
page	❌	integer	Номер страницы пагинации.

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=delete_config" \
--data "token=YOUR_TOKEN" \
--data "config_id=123"

Пример успешного ответа

{
"result": "OK",
"action": "delete_config",
"module": "res_proxy",
"data": [
{
"id": 1,
"name": "Deleted Config",
"country": "US",
"protocol": "http",
"quantity": 5,
"config_type": "standard"
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_action_error"
}

res_proxy/regenerate_config¶

Перегенерирует сессии для существующей конфигурации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `regenerate_config`
token	✅	string	Токен авторизации
config_id	✅	integer	ID конфигурации для перегенерации.

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=regenerate_config" \
--data "token=HOSTKEY_TOKEN" \
--data "config_id=VALUE"

Пример успешного ответа

{
"result": "OK",
"action": "regenerate_config",
"module": "res_proxy",
"data": {
"session_ids": "1,2,3,4,5",
"quantity": 5
},
"callback": "7bc29eb23fb1b879b21fce509597f07c"
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_action_error"
}

res_proxy/update_config¶

Обновляет параметры существующей конфигурации резидентных прокси, включая название, страну, протокол и количество сессий.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update_config`
token	✅	string	Токен авторизации пользователя
config_id	✅	integer	Уникальный идентификатор конфигурации для обновления
name	✅	string	Название конфигурации. Не может быть пустым.
country	✅	string	Страна прокси-сервера. Не может быть пустым.
protocol	✅	string	Протокол передачи данных. Не может быть пустым.
count	✅	integer	Количество прокси-серверов. Допустимые значения: от 1 до 500.
config_type	✅	string	Тип конфигурации (например, sticky или single). Не может быть пустым.
page	✅	integer	Номер страницы для обновления списка после операции. По умолчанию 1.
show_by	✅	integer	Параметр отображения (фильтр) для обновления списка конфигураций. Не может быть пустым.
region	❌	string	Регион прокси-сервера (опционально).
city	❌	string	Город прокси-сервера (опционально).

Пример запроса

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=update_config" \
--data "token=VALUE" \
--data "config_id=VALUE" \
--data "name=VALUE" \
--data "country=VALUE" \
--data "protocol=VALUE" \
--data "count=VALUE" \
--data "config_type=VALUE" \
--data "page=1" \
--data "show_by=1"

Пример успешного ответа

{
"result": "OK",
"action": "update_config",
"data": [
{
"id": 123,
"name": "My Proxy Config",
"country": "US",
"protocol": "http",
"quantity": 50,
"config_type": "sticky",
"session_type": "sticky",
"session_ttl": 600,
"gate": 1
}
]
}

Примеры ошибок

{
"code": -3,
"message": "res_proxy_not_enough_parameters"
}