Documentação da API AfricaProxies

Autenticação

Todos os pedidos, exceto o catálogo público, incluem uma chave API: Authorization: Bearer API_KEY. A chave é mostrada na íntegra uma vez, quando a cria: guarde-a como uma palavra-passe. Revogue uma chave a qualquer momento; os pedidos efetuados com ela passam a devolver 401 unauthorized.

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

Pedidos e respostas

• JSON na entrada, JSON na saída: envie Content-Type: application/json quando incluir um corpo.
• Listas que podem crescer são paginadas com page (a partir de 1) e perPage (1–100, predefinição 20) e devolvem { "data": [...], "pagination": { "page", "perPage", "total", "totalPages" } }. Listas curtas devolvem { "data": [...] }.
• Identificadores são cadeias opacas com um prefixo de tipo: ord_ (encomenda), top_ (carregamento), txn_ (movimento do saldo), res_ (subscrição de tráfego), mob_ (porta móvel), key_ (chave API) e ipw_ (entrada da lista de IP permitidos).
• Repetições seguras: POST /v1/orders e POST /v1/topups aceitam um cabeçalho Idempotency-Key (qualquer cadeia única, conservada durante 24 h). Repetir a mesma chave devolve a primeira resposta em vez de comprar ou carregar duas vezes.
• Os exemplos mostram a estrutura de cada resposta: identificadores, endereços, montantes e datas são ilustrativos; os identificadores dos planos e os preços são reais.

Erros

Todos os erros têm o mesmo corpo. code é estável e destina-se ao seu código; message é uma frase em inglês que pode mudar. Os erros de validação enumeram cada campo inválido em fields. Podem ser acrescentados novos códigos: trate os desconhecidos como uma falha genérica.

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

Cada resposta inclui RateLimit-Limit, RateLimit-Remaining e RateLimit-Reset. Acima do limite, a API responde 429 rate_limited com um cabeçalho Retry-After (segundos): aguarde esse tempo e tente novamente. O IP de uma porta móvel pode ser alterado no máximo uma vez a cada 30 segundos (429 rotation_too_soon, com Retry-After).