Перейти к основному содержимому

Доступы к прокси (Sub-users)

Доступ к прокси (sub-user) — это пара логин/пароль, используемая для аутентификации на шлюзе прокси. У каждого доступа может быть собственный лимит трафика, и его можно независимо приостановить или отозвать. Создавайте доступы, чтобы выдавать ограниченные учетные данные, а затем стройте имена пользователей для подключения из их real_login (см. Грамматика имени пользователя).

В вашей подписке всегда есть один основной доступ (is_primary: true), который нельзя изменить или удалить.

Список доступов​

Endpoint​

GET /api/v2/rotating-proxies/sub-users/

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

ПараметрТипОбязательныйОписание
searchstringНетФильтр по логину или комментарию
pageintegerНетНомер страницы
page_sizeintegerНетКоличество результатов на странице

Запрос​

curl -X 'GET' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here'

Ответ​

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "0f8c4b2e-2d2a-4a7e-9b6a-1f0c2d3e4f5a",
      "login": "primary",
      "real_login": "u12ab",
      "password": "S3cretPass",
      "status": "active",
      "traffic_limit_mb": null,
      "traffic_left_mb": null,
      "comment": "",
      "is_primary": true,
      "provisioning_status": "active"
    },
    {
      "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
      "login": "worker1",
      "real_login": "u12ab_worker1",
      "password": "Str0ngPass",
      "status": "active",
      "traffic_limit_mb": 10240,
      "traffic_left_mb": 8730,
      "comment": "scraper",
      "is_primary": false,
      "provisioning_status": "active"
    }
  ]
}

Поля ответа​

ПолеТипОписание
idstringUUID доступа (используйте его в /sub-users/{id}/)
loginstringЧитаемая метка, которую вы задали
real_loginstringБазовое имя пользователя для аутентификации на прокси
passwordstringПароль для аутентификации на прокси
statusstringactive или paused
traffic_limit_mbinteger|nullЛимит трафика на доступ в МБ (null = без лимита)
traffic_left_mbinteger|nullОстаток трафика для этого доступа (null = без лимита)
commentstringПроизвольная заметка
is_primarybooleanЯвляется ли это неизменяемым основным доступом
provisioning_statusstringpending, active или failed

Создать доступ (Generate)​

Создает новый доступ к прокси и провижинит его на шлюзе.

Endpoint​

POST /api/v2/rotating-proxies/sub-users/

Тело запроса​

ПолеТипОбязательныйОписание
loginstringДаМетка и основа логина, 3–50 символов, [a-zA-Z0-9]
passwordstringДаПароль, 3–50 символов, [a-zA-Z0-9]
traffic_limit_mbintegerНетЛимит трафика на доступ в МБ (не может превышать общий объем плана)
commentstringНетПроизвольная заметка (макс. 500 символов)

Запрос​

curl -X 'POST' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{
    "login": "worker1",
    "password": "Str0ngPass",
    "traffic_limit_mb": 10240,
    "comment": "scraper"
  }'

Ответ (201)​

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "active",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 10240,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Получить доступ​

Возвращает один доступ, включая real_login и password, необходимые для подключения.

Endpoint​

GET /api/v2/rotating-proxies/sub-users/{id}/

Запрос​

curl -X 'GET' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here'

Ответ​

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "active",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 8730,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Изменить доступ​

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

Endpoint​

PATCH /api/v2/rotating-proxies/sub-users/{id}/

Тело запроса​

ПолеТипОбязательныйОписание
loginstringНетНовая метка/основа логина, 3–50 символов, [a-zA-Z0-9]
passwordstringНетНовый пароль, 3–50 символов, [a-zA-Z0-9]
traffic_limit_mbintegerНетНовый лимит трафика в МБ
commentstringНетНовая заметка
statusstringНетactive или paused

Запрос​

curl -X 'PATCH' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'accept: application/json' \
  -H 'X-Api-Key: your_api_key_here' \
  -H 'Content-Type: application/json' \
  -d '{ "status": "paused" }'

Ответ​

{
  "id": "9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
  "login": "worker1",
  "real_login": "u12ab_worker1",
  "password": "Str0ngPass",
  "status": "paused",
  "traffic_limit_mb": 10240,
  "traffic_left_mb": 8730,
  "comment": "scraper",
  "is_primary": false,
  "provisioning_status": "active"
}

Отозвать доступ (Delete)​

Безвозвратно удаляет неосновной доступ и удаляет его со шлюза.

Endpoint​

DELETE /api/v2/rotating-proxies/sub-users/{id}/

Запрос​

curl -X 'DELETE' \
  'https://app.cyberyozh.com/api/v2/rotating-proxies/sub-users/9a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d/' \
  -H 'X-Api-Key: your_api_key_here'

Ответ​

204 No Content — пустое тело.

Ответы с ошибками​

Ошибка валидации (400)​

{
  "login": [
    "This value does not match the required pattern."
  ]
}

Слишком высокий лимит трафика (400)​

{
  "detail": "traffic_limit_mb cannot exceed plan total (51200 MB)."
}

Логин уже существует (409)​

{
  "detail": "Login already exists."
}

Основной доступ неизменяем (400)​

{
  "detail": "Primary user cannot be deleted."
}

Нет активной подписки (404)​

{
  "detail": "No active rotating proxy subscription."
}

Примечания​

  • real_login отличается от метки login: это фактическое имя пользователя на шлюзе, к которому вы добавляете суффиксы таргетинга.
  • Приостановленный доступ (status: paused) не может аутентифицироваться, пока не будет снова активирован.
  • Установка traffic_limit_mb ограничивает, сколько полосы пропускания этот доступ может потребить из общего баланса вашего плана.