# 🔌 OpenAPI

EProxies expose 5 endpoints HTTP (extraction de proxys en mode liste blanche et gestion de la liste blanche). Cette page est un aide-mémoire ; pour l'usage détaillé, voir [Extraction API (mode liste blanche)](https://www.eproxies.io/docs/usage/api-extraction).

> Définition lisible par machine : [openapi.json](https://www.eproxies.io/docs/openapi.json) — une spécification OpenAPI 3.0 à importer directement dans Postman / Swagger UI / Insomnia, ou à fournir à un agent IA pour un appel automatique.

## Informations de base

| Élément | Valeur |
| --- | --- |
| URL de base | `https://api.eproxies.net` |
| Auth (extraction) | La requête doit provenir d'une **IP en liste blanche** ; aucun identifiant requis |
| Auth (gestion) | Paramètres `userName` + `userKeyValue` (clé utilisateur, depuis le tableau de bord) |
| Passerelle proxy | `proxy.eproxies.net:23333` (HTTP/HTTPS/SOCKS5 — hors de cette API HTTP) |

## Liste des endpoints

### `GET /gateway_api/extract_ip`

Extraire des proxys — Extraire un lot de points de terminaison proxy. La requête doit provenir d'une IP en liste blanche ; les proxys renvoyés s'utilisent directement, sans identifiants.

**Paramètres de requête**

| Champ | Type | Requis | Valeurs admises | Description |
| --- | --- | --- | --- | --- |
| `count` | integer | Oui | `1` ~ N | Nombre de proxys à extraire |
| `country` | string | Non | `US` `GB` `JP` … / `Global` | Code pays ISO 3166-1 alpha-2 ; `Global` = tous pays |
| `protocol` | string | Non | `http` / `socks5` | Protocole du proxy |
| `format` | string | Non | `txt` / `json` | Format de réponse ; `json` renvoie un tableau d'objets, `txt` des lignes de texte brut |
| `separator` | string | Non | `crlf` `br` `cr` `lf` `tab` | Séparateur pour le format `txt` : respectivement `\r\n`, `</br>`, `\r`, `\n`, `\t` |
| `st` | string | Non | — | Séparateur personnalisé ; remplace `separator` s'il est fourni |
| `session` | string | Non | `sticky` / `random` | Type d'IP : `sticky` réutilise le même lot, `random` renvoie des IP aléatoires |

**Champs de réponse**

| Champ | Type | Description |
| --- | --- | --- |
| `ipAddress` | string | Adresse IP du proxy |
| `portValue` | integer | Port du proxy |

Avec `format=json`, la réponse est un tableau des objets ci-dessus ; avec `format=txt`, ce sont des lignes `IP:port` séparées par `separator`.

**Exemple**

```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`

Liste des pays pris en charge — Liste tous les pays disponibles pour l'extraction en mode liste blanche.

**Paramètres de requête**

Aucun paramètre de requête.

**Champs de réponse**

| Champ | Type | Description |
| --- | --- | --- |
| `country` | string | Code ISO 3166-1 alpha-2 — à utiliser comme paramètre `country` de `extract_ip` |
| `name` | string | Nom du pays |
| `flag_url` | string | URL de l'icône du drapeau |

**Exemple**

```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`

Ajouter une IP à la liste blanche — Ajoute une IP de sortie à la liste blanche ; cette IP peut alors extraire des proxys sans identifiants.

**Paramètres de requête**

| Champ | Type | Requis | Valeurs admises | Description |
| --- | --- | --- | --- | --- |
| `userName` | string | Oui | — | Nom d'utilisateur du compte |
| `userKeyValue` | string | Oui | — | Clé utilisateur, depuis le tableau de bord |
| `ipAddress` | string | Oui | — | Adresse IP à ajouter à la liste blanche |

**Champs de réponse**

Renvoie un objet de résultat ; se référer à la réponse réelle.

**Exemple**

```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`

Supprimer une IP de la liste blanche — Retire une IP de la liste blanche ; elle ne peut plus extraire sans identifiants.

**Paramètres de requête**

| Champ | Type | Requis | Valeurs admises | Description |
| --- | --- | --- | --- | --- |
| `userName` | string | Oui | — | Nom d'utilisateur du compte |
| `userKeyValue` | string | Oui | — | Clé utilisateur, depuis le tableau de bord |
| `ipAddress` | string | Oui | — | IP à retirer de la liste blanche |

**Champs de réponse**

Renvoie un objet de résultat ; se référer à la réponse réelle.

**Exemple**

```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`

Consulter la liste blanche — Liste toutes les entrées de la liste blanche du compte courant.

**Paramètres de requête**

| Champ | Type | Requis | Valeurs admises | Description |
| --- | --- | --- | --- | --- |
| `userName` | string | Oui | — | Nom d'utilisateur du compte |
| `userKeyValue` | string | Oui | — | Clé utilisateur, depuis le tableau de bord |

**Champs de réponse**

| Champ | Type | Description |
| --- | --- | --- |
| `ipAddress` | string | IP en liste blanche |
| `remarkText` | string | Remarque |

**Exemple**

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

## Appel rapide

```bash
# Extraire 10 proxys HTTP américains (JSON, IP persistantes)
curl "https://api.eproxies.net/gateway_api/extract_ip?count=10&country=US&protocol=http&format=json&session=sticky"

# Ajouter l'IP du serveur actuel à la liste blanche
curl "https://api.eproxies.net/gateway_api/add-ip?userName=USERNAME&userKeyValue=USER_KEY&ipAddress=203.0.113.10"
```

## Utilisation depuis un agent IA

Indiquez l'URL de la spécification à votre agent : il en déduira seul tous les paramètres et structures de réponse.

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

Avec l'[aide-mémoire Agent](https://www.eproxies.io/docs/agent-reference) (syntaxe des paramètres du username pour la passerelle proxy), vous disposez de toute la surface d'intégration.