# 🔌 OpenAPI

EProxies предоставляет 5 HTTP-эндпоинтов (извлечение прокси в режиме белого списка и управление белым списком). Эта страница — краткий справочник; подробное использование см. в разделе [Извлечение по API (режим белого списка)](https://www.eproxies.io/docs/usage/api-extraction).

> Машиночитаемое описание: [openapi.json](https://www.eproxies.io/docs/openapi.json) — спецификация OpenAPI 3.0, которую можно импортировать в Postman / Swagger UI / Insomnia или передать ИИ-агенту для автоматических вызовов.

## Основные сведения

| Параметр | Значение |
| --- | --- |
| Базовый URL | `https://api.eproxies.net` |
| Аутентификация (извлечение) | Запрос должен исходить с **IP из белого списка**; учётные данные не нужны |
| Аутентификация (управление) | Параметры `userName` + `userKeyValue` (ключ пользователя, из личного кабинета) |
| Шлюз прокси | `proxy.eproxies.net:23333` (HTTP/HTTPS/SOCKS5 — вне этого HTTP API) |

## Список эндпоинтов

### `GET /gateway_api/extract_ip`

Извлечение прокси — Извлекает партию прокси-эндпоинтов. Запрос должен исходить с IP из белого списка; полученные прокси используются напрямую, без учётных данных.

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

| Поле | Тип | Обяз. | Допустимые значения | Описание |
| --- | --- | --- | --- | --- |
| `count` | integer | Да | `1` ~ N | Количество прокси для извлечения |
| `country` | string | Нет | `US` `GB` `JP` … / `Global` | Код страны ISO 3166-1 alpha-2; `Global` — любая страна |
| `protocol` | string | Нет | `http` / `socks5` | Протокол прокси |
| `format` | string | Нет | `txt` / `json` | Формат ответа; `json` — массив объектов, `txt` — строки текста |
| `separator` | string | Нет | `crlf` `br` `cr` `lf` `tab` | Разделитель для формата `txt`: соответственно `\r\n`, `</br>`, `\r`, `\n`, `\t` |
| `st` | string | Нет | — | Пользовательский разделитель; заменяет `separator` |
| `session` | string | Нет | `sticky` / `random` | Тип IP: `sticky` — повторное использование той же партии, `random` — случайные |

**Поля ответа**

| Поле | Тип | Описание |
| --- | --- | --- |
| `ipAddress` | string | IP-адрес прокси |
| `portValue` | integer | Порт прокси |

При `format=json` ответ — массив объектов выше; при `format=txt` — строки `IP:порт`, разделённые `separator`.

**Пример**

```bash
curl "https://api.eproxies.net/gateway_api/extract_ip?count=10&country=US&protocol=http&format=json&session=sticky"
```

```json
[
  { "ipAddress": "203.0.113.10", "portValue": 23333 },
  { "ipAddress": "203.0.113.11", "portValue": 23333 }
]
```

### `GET /gateway_api/country-list`

Список поддерживаемых стран — Возвращает все страны, доступные для извлечения в режиме белого списка.

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

Параметров запроса нет.

**Поля ответа**

| Поле | Тип | Описание |
| --- | --- | --- |
| `country` | string | Код ISO 3166-1 alpha-2 — используется как параметр `country` в `extract_ip` |
| `name` | string | Название страны |
| `flag_url` | string | URL иконки флага |

**Пример**

```bash
curl "https://api.eproxies.net/gateway_api/country-list"
```

```json
[
  { "country": "US", "name": "United States", "flag_url": "https://file.eproxies.net/flags/us.png" }
]
```

### `GET /gateway_api/add-ip`

Добавить IP в белый список — Добавляет исходящий IP в белый список; после этого с него можно извлекать прокси без учётных данных.

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

| Поле | Тип | Обяз. | Допустимые значения | Описание |
| --- | --- | --- | --- | --- |
| `userName` | string | Да | — | Имя пользователя аккаунта |
| `userKeyValue` | string | Да | — | Ключ пользователя, из личного кабинета |
| `ipAddress` | string | Да | — | IP-адрес для добавления в белый список |

**Поля ответа**

Возвращает объект результата операции; ориентируйтесь на фактический ответ.

**Пример**

```bash
curl "https://api.eproxies.net/gateway_api/add-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
```

### `GET /gateway_api/del-ip`

Удалить IP из белого списка — Удаляет IP из белого списка; после этого извлечение без учётных данных с него невозможно.

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

| Поле | Тип | Обяз. | Допустимые значения | Описание |
| --- | --- | --- | --- | --- |
| `userName` | string | Да | — | Имя пользователя аккаунта |
| `userKeyValue` | string | Да | — | Ключ пользователя, из личного кабинета |
| `ipAddress` | string | Да | — | IP для удаления из белого списка |

**Поля ответа**

Возвращает объект результата операции; ориентируйтесь на фактический ответ.

**Пример**

```bash
curl "https://api.eproxies.net/gateway_api/del-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
```

### `GET /gateway_api/lists-ip`

Показать белый список — Возвращает все записи белого списка текущего аккаунта.

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

| Поле | Тип | Обяз. | Допустимые значения | Описание |
| --- | --- | --- | --- | --- |
| `userName` | string | Да | — | Имя пользователя аккаунта |
| `userKeyValue` | string | Да | — | Ключ пользователя, из личного кабинета |

**Поля ответа**

| Поле | Тип | Описание |
| --- | --- | --- |
| `ipAddress` | string | IP из белого списка |
| `remarkText` | string | Примечание |

**Пример**

```bash
curl "https://api.eproxies.net/gateway_api/lists-ip?userName=USERNAME&userKeyValue=USER_KEY"
```

## Быстрый вызов

```bash
# Извлечь 10 HTTP-прокси США (JSON, липкие IP)
curl "https://api.eproxies.net/gateway_api/extract_ip?count=10&country=US&protocol=http&format=json&session=sticky"

# Добавить IP текущего сервера в белый список
curl "https://api.eproxies.net/gateway_api/add-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
```

## Использование в ИИ-агенте

Передайте агенту адрес спецификации — он сам разберётся во всех параметрах и структурах ответа:

```
https://www.eproxies.io/docs/openapi.json
```

Вместе со [Шпаргалкой для агентов](https://www.eproxies.io/docs/agent-reference) (синтаксис параметров username для шлюза) это покрывает всю поверхность интеграции.