res_proxy.php¶

В этой статье

Методы API

res_proxy/add_new_plan

res_proxy/create_config

res_proxy/delete_config

res_proxy/delete_plan

res_proxy/delete_user

res_proxy/get_cities

res_proxy/get_configs

res_proxy/get_params

res_proxy/get_plan_history

res_proxy/get_plan_users

res_proxy/get_regions

res_proxy/list_plans

res_proxy/regenerate_config

res_proxy/resume_user

res_proxy/suspend_user

res_proxy/update_config

res_proxy/update_plan

res_proxy/update_stats

Административный модуль управления резидентными прокси: управление тарифными планами, пользователями и мониторинг истории изменений

Методы API¶

Метод	Действие	Описание
`add_new_plan`	создание нового тарифного плана	Создает новый тарифный план с указанием лимитов и стоимости в различных валютах.
`create_config`	создание конфигурации	Создает новую конфигурацию прокси-серверов с заданными параметрами (страна, протокол, количество) и возвращает обновленный список доступных конфигураций.
`delete_config`	удаление конфигурации	Удаляет существующую конфигурацию прокси-серверов по её ID.
`delete_plan`	удаление тарифного плана	Удаляет существующий тарифный план по его ID.
`delete_user`	удаление пользователя	Удаляет пользователя из системы.
`get_cities`	получение списка городов	Возвращает список доступных городов для выбранной страны и региона.
`get_configs`	получение списка конфигураций	Возвращает список конфигураций прокси для клиента.
`get_params`	получение параметров	Возвращает доступные параметры конфигурации прокси для пользователя
`get_plan_history`	получение истории плана	Возвращает историю изменений конкретного тарифного плана
`get_plan_users`	получение пользователей плана	Возвращает список пользователей, привязанных к тарифному плану
`get_regions`	получение регионов	Возвращает список доступных регионов для указанной страны
`list_plans`	получение планов	Возвращает список всех доступных тарифных планов
`regenerate_config`	регенерация конфигурации	Запускает процесс регенерации параметров сессий для указанной конфигурации.
`resume_user`	возобновление пользователя	Возобновляет действие заблокированного пользователя
`suspend_user`	блокировка пользователя	Приостанавливает действие пользователя (блокирует доступ) по указанной причине.
`update_config`	обновление конфигурации прокси	Обновляет параметры существующей конфигурации резидентных прокси (название, страна, протокол, количество и тип).
`update_plan`	обновление тарифного плана	Изменяет параметры тарифного плана: название, статус, лимиты и стоимость в разных валютах.
`update_stats`	обновление статистики	Запускает процесс пересчета системной статистики прокси-серверов.

res_proxy/add_new_plan¶

Создает новый тарифный план с указанием лимитов и стоимости в различных валютах.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: add_new_plan
token	✅	string	Токен авторизации
plan_name	✅	string	Название тарифного плана.
plan_active	✅	boolean	Статус активности плана. Допустимые значения: true, false.
plan_limit	✅	integer	Лимит трафика в ГБ.
plan_eur	✅	number	Стоимость плана в EUR.
plan_rub	✅	number	Стоимость плана в RUB.
plan_usd	✅	number	Стоимость плана в USD.

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

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=add_new_plan" \
--data "token=HOSTKEY_TOKEN" \
--data "plan_name=Premium Plan" \
--data "plan_active=true" \
--data "plan_limit=100" \
--data "plan_eur=50.0" \
--data "plan_rub=5000.0" \
--data "plan_usd=55.0"

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

{
"result": "OK",
"action": "add_new_plan",
"plans": [
{
"id": 1,
"name": "Premium Plan",
"active": 1,
"bandwidth_limit_gb": 100,
"rate_rub": 5000.0,
"rate_eur": 50.0,
"rate_usd": 55.0
}
],
"history": [
{
"id": 123,
"event": "Plan created",
"created_at": "2024-01-15T10:30:00Z"
}
],
"inserted_id": 1
}

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

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

res_proxy/create_config¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `create_config`
token	✅	string	Токен авторизации
name	✅	string	Название конфигурации. Не может быть пустым.
country	✅	string	Страна расположения прокси. Не может быть пустой.
protocol	✅	string	Протокол передачи данных. Не может быть пустым.
count	✅	integer	Количество прокси-серверов в конфигурации.
config_type	✅	string	Тип конфигурации. Не может быть пустым.
page	❌	integer	Номер страницы для пагинации списка.
show_by	✅	string	Параметр группировки/отображения в списке конфигураций.
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",
"data": [
{
"id": 105,
"name": "Premium Proxy Set",
"country": "NL",
"protocol": "http",
"quantity": 50,
"status": "active"
}
]
}

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

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

res_proxy/delete_config¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "delete_config",
"data": [
{
"id": 105,
"name": "Premium Proxy Set",
"country": "NL",
"protocol": "http",
"quantity": 50,
"status": "active"
}
]
}

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

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

res_proxy/delete_plan¶

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

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "delete_plan",
"plans": []
}

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

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

res_proxy/delete_user¶

Удаляет пользователя из системы.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "delete_user",
"deleted": "ok",
"users": []
}

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

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

res_proxy/get_cities¶

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

HTTP-метод: GET

Параметры:

action	✅	string	Идентификатор метода: `get_cities`
token	✅	string	Токен авторизации
country	✅	string	Код страны.
region	❌	string	Код региона.

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

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

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

{
"result": "OK",
"action": "get_cities",
"cities": [
{
"id": 1,
"name": "New York",
"code": "NY"
}
]
}

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

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

res_proxy/get_configs¶

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

HTTP-метод: GET

Параметры:

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

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

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

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

{
"result": "OK",
"action": "get_configs",
"config_data": [
{
"id": 10,
"name": "My Proxy Config",
"country": "US",
"protocol": "http"
}
]
}

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

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

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": "Proxy Group 1",
"status": "active",
"count": 50
}
]
}

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

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

res_proxy/get_plan_history¶

Возвращает историю изменений конкретного тарифного плана

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "get_plan_history",
"module": "res_proxy",
"history": [
{
"id": 101,
"event": "Plan updated",
"created_at": "2024-05-20T12:00:00Z"
}
]
}

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

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

res_proxy/get_plan_users¶

Возвращает список пользователей, привязанных к тарифному плану

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `get_plan_users`
token	✅	string	Токен авторизации
plan_id	✅	integer	ID тарифного плана. Обязателен.
email	❌	string	Электронная почта пользователя для фильтрации списка участников плана.

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

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

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

{
"result": "OK",
"action": "get_plan_users",
"module": "res_proxy",
"users": [
{
"id": 50,
"email": "user@example.com",
"status": "active"
}
]
}

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

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

res_proxy/get_regions¶

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

HTTP-метод: POST

Параметры:

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

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

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",
"regions": [
{
"code": "US",
"name": "United States"
}
],
"cities": [
{
"id": 10,
"name": "New York"
}
]
}

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

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

res_proxy/list_plans¶

Возвращает список всех доступных тарифных планов

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: list_plans
token	✅	string	Токен авторизации

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

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

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

{
"result": "OK",
"action": "list_plans",
"module": "res_proxy",
"plans": [
{
"id": 1,
"name": "Premium Plan",
"active": 1,
"limit": 500,
"price": {
"EUR": 49.99,
"RUB": 4500,
"USD": 54.99
}
}
]
}

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

{}

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",
"data": {
"session_ids": "abc123def456ghi789jkl012mno345pqr",
"ip_list": [
"1.2.3.4",
"5.6.7.8"
]
}
}

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

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

res_proxy/resume_user¶

Возобновляет действие заблокированного пользователя

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `resume_user`
token	✅	string	Токен авторизации
customer_id	✅	integer	ID клиента. Обязателен.
reason	✅	string	Причина возобновления пользователя.
plan_id	✅	integer	ID тарифного плана. Обязателен.

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

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=resume_user" \
--data "token=HOSTKEY_TOKEN" \
--data "customer_id=VALUE" \
--data "reason=VALUE" \
--data "plan_id=VALUE"

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

{
"result": "OK",
"action": "resume_user",
"module": "res_proxy",
"resumed": "ok",
"users": [
{
"id": 50,
"email": "user@example.com",
"status": "active"
}
]
}

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

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

res_proxy/suspend_user¶

Приостанавливает действие пользователя (блокирует доступ) по указанной причине.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `suspend_user`
token	✅	string	Токен авторизации
customer_id	✅	integer	ID клиента для блокировки
reason	✅	string	Причина блокировки
plan_id	✅	integer	ID плана пользователя

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

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=suspend_user" \
--data "token=HOSTKEY_TOKEN" \
--data "customer_id=VALUE" \
--data "reason=VALUE" \
--data "plan_id=VALUE"

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

{
"result": "OK",
"action": "suspend_user",
"suspended": "ok",
"users": [
{
"id": 101,
"email": "user@example.com",
"status": "active"
}
]
}

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

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

res_proxy/update_config¶

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

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update_config
token	✅	string	Токен авторизации
config_id	✅	integer	ID конфигурации для обновления
name	✅	string	Название конфигурации
country	✅	string	Страна прокси
protocol	✅	string	Протокол подключения
count	✅	integer	Количество прокси (от 1 до 500)
config_type	✅	string	Тип конфигурации
page	❌	integer	Номер страницы для обновления списка
show_by	✅	integer	Параметр отображения (ID страны/региона)
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 "show_by=VALUE"

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

{
"result": "OK",
"action": "update_config",
"data": [
{
"id": 123,
"name": "Premium US Proxy",
"country": "US",
"protocol": "http",
"quantity": 50,
"config_type": "residential",
"region": "NY",
"city": "New York"
}
]
}

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

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

res_proxy/update_plan¶

Изменяет параметры тарифного плана: название, статус, лимиты и стоимость в разных валютах.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: update_plan
token	✅	string	Токен авторизации
plan_id	✅	integer	ID тарифного плана
plan_name	✅	string	Название тарифного плана
plan_active	✅	boolean	Статус активности. Допустимые значения: true, false.
plan_limit	✅	integer	Лимит трафика в ГБ (от 0 до 1000000)
plan_eur	✅	number	Стоимость в EUR (от 0 до 1000000)
plan_rub	✅	number	Стоимость в RUB (от 0 до 1000000)
plan_usd	✅	number	Стоимость в USD (от 0 до 1000000)

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

curl -s "https://invapi.hostkey.ru/res_proxy.php" -X POST \
--data "action=update_plan" \
--data "token=HOSTKEY_TOKEN" \
--data "plan_id=5" \
--data "plan_name=Ultra Plan" \
--data "plan_active=true" \
--data "plan_limit=500" \
--data "plan_eur=45.5" \
--data "plan_rub=5000.0" \
--data "plan_usd=50.0"

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

{
"result": "OK",
"action": "update_plan",
"plans": [
{
"id": 5,
"name": "Ultra Plan",
"active": 1,
"bandwidth_limit_gb": 500,
"rate_rub": 5000.0,
"rate_eur": 45.5,
"rate_usd": 50.0
}
],
"history": [
{
"id": 10,
"event": "Plan id=5 was updated",
"old_data": "{\"name\":\"Old Name\"}",
"new_data": "{\"name\":\"Ultra Plan\"}"
}
]
}

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

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

res_proxy/update_stats¶

Запускает процесс пересчета системной статистики прокси-серверов.

HTTP-метод: POST

Параметры:

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

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

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

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

{
"result": "OK",
"action": "update_stats",
"stats": {
"total_proxies": 1500,
"active_sessions": 45,
"last_updated": "2024-05-20T12:00:00Z"
}
}

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

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