Documentation de l’API AfricaProxies

Authentification

Toute requête, hors catalogue public, utilise une clé API : Authorization: Bearer API_KEY. La clé n’est affichée intégralement qu’une fois, à sa création : conservez-la comme un mot de passe. Vous pouvez révoquer une clé à tout moment ; les requêtes qui l’utilisent renvoient alors 401 unauthorized.

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

Requêtes et réponses

• JSON en entrée, JSON en sortie : envoyez Content-Type: application/json avec un corps de requête.
• Les listes susceptibles de grandir utilisent la pagination avec page (à partir de 1) et perPage (1–100, valeur par défaut 20), et renvoient { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } }. Les listes courtes renvoient { "data": [...] }.
• Les IDs sont des chaînes opaques précédées d’un préfixe de type : ord_ (commande), top_ (rechargement), txn_ (mouvement du solde), res_ (abonnement de trafic), mob_ (port mobile), key_ (clé API) et ipw_ (entrée de la liste d’IP autorisées).
• Nouvelles tentatives sans doublon : POST /v1/orders et POST /v1/topups acceptent un en-tête Idempotency-Key, une chaîne unique conservée 24 h. Réutiliser cette clé renvoie la première réponse, sans nouvel achat ni second rechargement.
• Les exemples montrent la structure des réponses. Leurs IDs, adresses, montants et dates sont illustratifs ; les identifiants et prix des forfaits sont réels.

Erreurs

Chaque erreur possède le même corps. code est stable et destiné à votre code ; message est une phrase en anglais qui peut changer. Les erreurs de validation listent chaque champ invalide dans fields. De nouveaux codes peuvent être ajoutés : traitez les codes inconnus comme une erreur générique.

{
  "error": {
    "code": "validation_failed",
    "message": "Some fields are invalid.",
    "fields": [
      {
        "field": "amountUsd",
        "code": "too_small",
        "message": "The minimum top-up is 25.00 USD."
      }
    ],
    "requestId": "req_2b7c0f"
  }
}

Limites de débit

Chaque réponse comporte RateLimit-Limit, RateLimit-Remaining et RateLimit-Reset. Au-dessus de la limite, l'API répond 429 rate_limited avec un en-tête Retry-After (secondes) : attendez cette durée, puis réessayez. L'IP d'un port mobile peut être modifiée au plus une fois toutes les 30 secondes (429 rotation_too_soon, avec Retry-After).