Documentación de la API AfricaProxies

Autenticación

Todas las solicitudes, salvo el catálogo público, incluyen una clave API: Authorization: Bearer API_KEY. La clave se muestra completa una vez, al crearla: guárdala como una contraseña. Revoca una clave en cualquier momento; las solicitudes realizadas con ella pasarán a devolver 401 unauthorized.

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

Solicitudes y respuestas

• JSON de entrada, JSON de salida: envía Content-Type: application/json cuando incluyas un cuerpo.
• Las listas que pueden crecer se paginan con page (desde 1) y perPage (1–100, valor predeterminado 20) y devuelven { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } }. Las listas cortas devuelven { "data": [...] }.
• Los identificadores son cadenas opacas con un prefijo de tipo: ord_ (pedido), top_ (recarga), txn_ (movimiento del saldo), res_ (suscripción de tráfico), mob_ (puerto móvil), key_ (clave API) e ipw_ (entrada de la lista de IP permitidas).
• Reintentos seguros: POST /v1/orders y POST /v1/topups aceptan una cabecera Idempotency-Key (cualquier cadena única, conservada durante 24 h). Repetir la misma clave devuelve la primera respuesta en lugar de comprar o recargar dos veces.
• Los ejemplos muestran la estructura de cada respuesta: los identificadores, direcciones, importes y fechas son ilustrativos; los identificadores de planes y precios son reales.

Errores

Todos los errores tienen el mismo cuerpo. code es estable y está destinado a tu código; message es una frase en inglés que puede cambiar. Los errores de validación enumeran cada campo no válido en fields. Pueden añadirse códigos nuevos: trata los desconocidos como un fallo genérico.

{
  "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"
  }
}

Límites de solicitudes

Cada respuesta incluye RateLimit-Limit, RateLimit-Remaining y RateLimit-Reset. Por encima del límite, la API responde 429 rate_limited con una cabecera Retry-After (segundos): espera ese tiempo y vuelve a intentarlo. La IP de un puerto móvil puede cambiarse como máximo una vez cada 30 segundos (429 rotation_too_soon, con Retry-After).