v1 — Estável

API REST ShieldProx

Gerencie seus proxies programaticamente. Integre com seus scripts, automações e sistemas.

Autenticação

Todas as requisições precisam do header X-API-Key com sua chave de API.

Base URLhttps://shieldprox.com.br/api/v1

AutenticaçãoX-API-Key: sp_live_sua_chave_aqui

curl -H "X-API-Key: sp_live_sua_chave_aqui" \
  https://shieldprox.com.br/api/v1/proxies

Rate Limiting

Limite de 60 requisições por minuto por API Key. Os headers de resposta informam o estado atual.

X-RateLimit-Limit60 — limite total por minuto

X-RateLimit-RemainingRequisições restantes no período atual

X-RateLimit-ResetTimestamp ISO 8601 do reset do contador

Quando o limite é atingido, a API retorna 429 Too Many Requests com o header Retry-After: 60.

Endpoints

GET/proxiesListar todos os proxies

Retorna todos os seus proxies com status, credenciais e métricas de uptime.

Query params opcionais

typeipv4 | isp | mobileFiltrar por tipo

statusactive | expiredFiltrar por status (padrão: active)

sortexpires_at | created_atOrdenar por campo

curl -H "X-API-Key: sp_live_..." \
  "https://shieldprox.com.br/api/v1/proxies?type=ipv4"

{
  "data": [
    {
      "id": "uuid",
      "type": "ipv4",
      "host": "185.234.1.2",
      "port": 8080,
      "username": "user_abc",
      "password": "pass_xyz",
      "protocol": "http",
      "country": "BR",
      "status": "active",
      "health_score": 98,
      "uptime_7d": 99.8,
      "current_latency_ms": 127,
      "expires_at": "2026-07-05T00:00:00Z",
      "days_remaining": 29,
      "auto_renew": false
    }
  ],
  "meta": {
    "total": 3,
    "active": 3,
    "expiring_soon": 0
  }
}

GET/proxies/:idDetalhes de um proxy

Retorna todos os campos do proxy mais o histórico de uptime das últimas 24h.

curl -H "X-API-Key: sp_live_..." \
  "https://shieldprox.com.br/api/v1/proxies/uuid-do-proxy"

{
  "id": "uuid",
  "host": "185.234.1.2",
  ...
  "uptime_history": [
    {
      "hour": "2026-06-06T13:00:00Z",
      "uptime_pct": 100,
      "avg_latency_ms": 122
    }
  ]
}

POST/proxies/:id/checkTestar conectividade

writeRequer permissão write

Testa a conectividade do proxy agora e retorna IP externo, país e latência.

curl -X POST \
  -H "X-API-Key: sp_live_..." \
  "https://shieldprox.com.br/api/v1/proxies/uuid/check"

{
  "proxy_id": "uuid",
  "online": true,
  "ip": "185.234.1.2",
  "country": "BR",
  "city": "São Paulo",
  "latency_ms": 127,
  "checked_at": "2026-06-06T14:30:00Z"
}

POST/proxies/:id/renewRenovar com carteira

writeRequer permissão write e saldo na carteira

Renova o proxy debitando créditos da sua carteira ShieldProx.

curl -X POST \
  -H "X-API-Key: sp_live_..." \
  -H "Content-Type: application/json" \
  -d '{"period_months": 1}' \
  "https://shieldprox.com.br/api/v1/proxies/uuid/renew"

{
  "success": true,
  "proxy_id": "uuid",
  "new_expires_at": "2026-07-06T00:00:00Z",
  "amount_charged": 35.00,
  "wallet_balance_after": 212.50
}

GET/accountDados da conta

Retorna informações da conta, saldo da carteira e resumo dos proxies.

curl -H "X-API-Key: sp_live_..." \
  "https://shieldprox.com.br/api/v1/account"

{
  "id": "uuid",
  "email": "voce@email.com",
  "name": "João Silva",
  "wallet_balance": 247.50,
  "proxies": {
    "total": 3,
    "active": 3,
    "expiring_soon": 0,
    "expired": 0
  },
  "plan_summary": {
    "ipv4": 2,
    "isp": 1,
    "mobile": 0
  },
  "member_since": "2026-01-15T00:00:00Z"
}

GET/usageUso da API Key

Retorna estatísticas de uso da API Key atual e o estado do rate limit.

curl -H "X-API-Key: sp_live_..." \
  "https://shieldprox.com.br/api/v1/usage"

{
  "api_key": {
    "prefix": "sp_live_abc1234",
    "name": "Produção",
    "permissions": ["read", "write"],
    "last_used_at": "2026-06-06T14:30:00Z"
  },
  "rate_limit": {
    "limit": 60,
    "remaining": 58,
    "reset_at": "2026-06-06T14:31:00Z"
  },
  "usage": {
    "requests_today": 142,
    "requests_total": 1847
  }
}

Erros

Todos os erros retornam JSON com o campo error.

401API Key não fornecida, inválida ou revogada.

402Saldo insuficiente na carteira para a operação.

403A operação requer permissão write.

404Recurso não encontrado ou não pertence à sua conta.

429Rate limit excedido. Aguarde até o reset indicado em X-RateLimit-Reset.

500Erro interno. Tente novamente em alguns instantes.

{
  "error": "API Key inválida ou revogada.",
  "docs": "https://shieldprox.com.br/api-docs"
}

Exemplos de código

Python

import requests

API_KEY = "sp_live_sua_chave"
BASE = "https://shieldprox.com.br/api/v1"
headers = {"X-API-Key": API_KEY}

# Listar proxies
r = requests.get(f"{BASE}/proxies", headers=headers)
proxies = r.json()["data"]
print(f"{len(proxies)} proxies encontrados")

# Testar proxy
proxy_id = proxies[0]["id"]
r = requests.post(f"{BASE}/proxies/{proxy_id}/check", headers=headers)
print(r.json())

Node.js

const API_KEY = "sp_live_sua_chave";
const BASE = "https://shieldprox.com.br/api/v1";
const headers = { "X-API-Key": API_KEY };

// Listar proxies
const res = await fetch(`${BASE}/proxies`, { headers });
const { data } = await res.json();
console.log(`${data.length} proxies encontrados`);

// Usar como proxy HTTP no Node.js
import { HttpsProxyAgent } from "https-proxy-agent";
const proxy = data[0];
const agent = new HttpsProxyAgent(
  `http://${proxy.username}:${proxy.password}@${proxy.host}:${proxy.port}`
);

PHP

<?php
$api_key = "sp_live_sua_chave";
$base = "https://shieldprox.com.br/api/v1";

$ch = curl_init("$base/proxies");
curl_setopt_array($ch, [
    CURLOPT_HTTPHEADER => ["X-API-Key: $api_key"],
    CURLOPT_RETURNTRANSFER => true,
]);
$response = json_decode(curl_exec($ch), true);
$proxies = $response["data"];
echo count($proxies) . " proxies encontrados
";

cURL

# Listar proxies ativos
curl -H "X-API-Key: sp_live_sua_chave" \
  https://shieldprox.com.br/api/v1/proxies

# Lista em texto (host:porta:usuário:senha), pronta para Dolphin/AdsPower
curl -H "X-API-Key: sp_live_sua_chave" \
  "https://shieldprox.com.br/api/v1/proxies?format=txt" > proxies.txt

# Testar proxy específico
curl -X POST \
  -H "X-API-Key: sp_live_sua_chave" \
  https://shieldprox.com.br/api/v1/proxies/UUID/check

# Renovar proxy com carteira (1 mês)
curl -X POST \
  -H "X-API-Key: sp_live_sua_chave" \
  -H "Content-Type: application/json" \
  -d '{"period_months": 1}' \
  https://shieldprox.com.br/api/v1/proxies/UUID/renew

Pronto para começar?

Gere sua API Key no dashboard e comece a integrar em minutos.

Gerar API Key →