Référence API

Clés API et liste d’IP autorisées

Créez et révoquez des clés API aux autorisations limitées. Gérez la liste d’IP autorisées : jusqu’à 10 adresses sources peuvent utiliser les proxies sans nom d’utilisateur ni mot de passe.

Dernière mise à jour: 15 octobre 2026 · 5 min de lecture

Points d’accès de cette page

GET /v1/api-keys: Lister les clés API
POST /v1/api-keys: Créer une clé API
DELETE /v1/api-keys/{keyId}: Révoquer une clé API
GET /v1/ip-whitelist: Lister les IP autorisées
POST /v1/ip-whitelist: Ajouter une IP ou une plage à la liste d’autorisation
DELETE /v1/ip-whitelist/{entryId}: Supprimer une entrée de la liste d’autorisation

URL de base https://africaproxies.com/api/v1. Authentification, erreurs et limites : voir la présentation de l’API.

Lister les clés API

GET/v1/api-keys

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Réponse `200 OK`

{
  "data": [
    {
      "id": "key_5n2v8q",
      "name": "Rotation script",
      "prefix": "pk_4f9a2c",
      "scopes": [
        "read",
        "proxies"
      ],
      "createdAt": "2026-10-05T14:03:11Z",
      "lastUsedAt": null
    }
  ],
  "limit": 20
}

Exemples de code

curl

curl -s "https://africaproxies.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/api-keys", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Créer une clé API

POST/v1/api-keys

Le secret complet est retourné une seule fois.

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Corps de la requête

Champ	Type	Requis	Description
`name`	string	Oui	max. 60 caractères
`scopes`	array of `read` · `proxies` · `billing`	Oui	—

Exemple

{
  "name": "Rotation script",
  "scopes": [
    "read",
    "proxies"
  ]
}

Réponse `201 Created`

{
  "id": "key_5n2v8q",
  "name": "Rotation script",
  "prefix": "pk_4f9a2c",
  "scopes": [
    "read",
    "proxies"
  ],
  "createdAt": "2026-10-05T14:03:11Z",
  "lastUsedAt": null,
  "secret": "pk_4f9a2c8e1b7d3f6a9c2e5b8d1f4a7c0e"
}

Exemples de code

curl

curl -s -X POST "https://africaproxies.com/api/v1/api-keys" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Rotation script","scopes":["read","proxies"]}'

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/api-keys", headers=HEADERS, json={"name": "Rotation script", "scopes": ["read", "proxies"]}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ name: 'Rotation script', scopes: ['read', 'proxies'] }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Révoquer une clé API

DELETE/v1/api-keys/{keyId}

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Paramètres

Nom	Dans	Type	Requis	Description
`keyId`	path	string	Oui	—

Réponse `204 No Content`

Pas de corps : le code d'état est la réponse.

Exemples de code

curl

curl -s -X DELETE "https://africaproxies.com/api/v1/api-keys/key_5n2v8q" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/api-keys/key_5n2v8q", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/api-keys/key_5n2v8q`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

Lister les IP autorisées

GET/v1/ip-whitelist

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Réponse `200 OK`

{
  "data": [
    {
      "id": "ipw_8c1k2m",
      "cidr": "203.0.113.24",
      "label": "Office server",
      "createdAt": "2026-10-05T14:03:11Z"
    }
  ],
  "limit": 10
}

Exemples de code

curl

curl -s "https://africaproxies.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/ip-whitelist", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Ajouter une IP ou une plage à la liste d’autorisation

POST/v1/ip-whitelist

Accepte une adresse IPv4, un CIDR IPv4 de /24 à /32, une adresse IPv6 ou un CIDR IPv6 de /48 à /128. Les plages privées, de boucle locale et réservées sont rejetées (422). Actif à la passerelle sous 60 s.

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Corps de la requête

Champ	Type	Requis	Description
`cidr`	string	Oui	—
`label`	string	Non	max. 60 caractères

Exemple

{
  "cidr": "203.0.113.24",
  "label": "Office server"
}

Réponse `201 Created`

{
  "id": "ipw_8c1k2m",
  "cidr": "203.0.113.24",
  "label": "Office server",
  "createdAt": "2026-10-05T14:03:11Z"
}

Exemples de code

curl

curl -s -X POST "https://africaproxies.com/api/v1/ip-whitelist" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"cidr":"203.0.113.24","label":"Office server"}'

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.post(f"{API}/ip-whitelist", headers=HEADERS, json={"cidr": "203.0.113.24", "label": "Office server"}, timeout=30)
r.raise_for_status()
print(r.json())

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({ cidr: '203.0.113.24', label: 'Office server' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());

Supprimer une entrée de la liste d’IP autorisées

DELETE/v1/ip-whitelist/{entryId}

Authentification : clé API dans l'en-tête Authorization: Bearer API_KEY.

Paramètres

Nom	Dans	Type	Requis	Description
`entryId`	path	string	Oui	—

Réponse `204 No Content`

Pas de corps : le code d'état est la réponse.

Exemples de code

curl

curl -s -X DELETE "https://africaproxies.com/api/v1/ip-whitelist/ipw_8c1k2m" \
  -H "Authorization: Bearer $API_KEY"

Python

import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.delete(f"{API}/ip-whitelist/ipw_8c1k2m", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.status_code)  # 204: done

Node.js

// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/ip-whitelist/ipw_8c1k2m`, {
  method: 'DELETE',
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(res.status); // 204: done

Lister les clés API

Réponse 200 OK

Exemples de code

Créer une clé API

Corps de la requête

Réponse 201 Created

Exemples de code

Révoquer une clé API

Paramètres

Réponse 204 No Content

Exemples de code

Lister les IP autorisées

Réponse 200 OK

Exemples de code

Ajouter une IP ou une plage à la liste d’autorisation

Corps de la requête

Réponse 201 Created

Exemples de code

Supprimer une entrée de la liste d’IP autorisées

Paramètres

Réponse 204 No Content

Exemples de code

Pages liées

Réponse `200 OK`

Réponse `201 Created`

Réponse `204 No Content`

Réponse `200 OK`

Réponse `201 Created`

Réponse `204 No Content`