AfricaProxies-API-Dokumentation

Authentifizierung

Jede Anfrage außer dem öffentlichen Katalog enthält einen API-Schlüssel: Authorization: Bearer API_KEY. Ein Schlüssel wird nur einmal vollständig angezeigt, bei seiner Erstellung: Speichere ihn wie ein Passwort. Du kannst ihn jederzeit widerrufen; Anfragen damit geben dann 401 unauthorized zurück.

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

Anfragen und Antworten

• JSON rein, JSON raus: Sende Content-Type: application/json bei einem Body.
• Listen, die wachsen können, werden mit page (ab 1) und perPage (1–100, Standard 20) paginiert und geben { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } } zurück. Kurze Listen geben { "data": [...] } zurück.
• IDs sind Zeichenfolgen ohne auszuwertende Struktur mit Typpräfix: ord_ (Bestellung), top_ (Aufladung), txn_ (Kontobewegung), res_ (Datenabo), mob_ (mobiler Port), key_ (API-Schlüssel) und ipw_ (Eintrag der IP-Freigabeliste).
• Sichere Wiederholungen: POST /v1/orders und POST /v1/topups akzeptieren einen Idempotency-Key-Header (beliebige eindeutige Zeichenfolge, 24 h gespeichert). Dieselbe Kennung liefert erneut die erste Antwort, statt doppelt zu kaufen oder aufzuladen.
• Beispiele zeigen die Antwortstruktur: IDs, Adressen, Beträge und Daten sind illustrativ, Tarif-IDs und Preise sind echt.

Fehler

Jeder Fehler hat dieselbe Body-Struktur. code ist stabil und für deinen Code gedacht; message ist ein englischer Satz, der sich ändern kann. Validierungsfehler nennen jedes ungültige Feld in fields. Neue Codes können hinzukommen: Behandle unbekannte Codes als allgemeinen Fehler.

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

Anfragelimits

Jede Antwort enthält RateLimit-Limit, RateLimit-Remaining und RateLimit-Reset. Über dem Limit antwortet die API mit 429 rate_limited und einem Retry-After-Header (Sekunden): Warte so lange und versuche es erneut. Die IP eines mobilen Ports lässt sich höchstens einmal alle 30 Sekunden ändern (429 rotation_too_soon, mit Retry-After).