# Encomendas

> API AfricaProxies: planos, preços, compra com saldo e histórico de encomendas. Parâmetros, respostas de exemplo e código curl, Python e Node.js.

- URL: https://africaproxies.com/pt/docs/api/orders/
- Última atualização: 2026-10-15
- Editor: AfricaProxies (https://africaproxies.com)

Liste os planos e os preços, compre um plano com o saldo (novo serviço, mais tráfego ou prolongamento de uma porta) e consulte encomendas anteriores.

**Endpoints nesta página**

- `GET /v1/catalog/products`: Produtos, planos e preços
- `POST /v1/orders`: Comprar um plano com o saldo (novo serviço, mais tráfego ou prolongamento de porta)
- `GET /v1/orders`: Listar encomendas
- `GET /v1/orders/{orderId}`: Obter uma encomenda

URL base `https://africaproxies.com/api/v1`. Autenticação, erros e limites: consulte a [visão geral da API](/pt/docs/api/).

## Produtos, planos e preços

`GET /v1/catalog/products`

Cada produto com os seus planos e preços, exatamente como são cobrados na encomenda.

Público: não é necessária uma chave API.

**Resposta** `200 OK`

```json
{
  "data": [
    {
      "id": "residential",
      "name": "Residential proxies",
      "description": "Residential IPs across 49 African locations for public price research, local SEO and your application tests. Prepaid traffic, billed per GB.",
      "unit": "GB",
      "plans": [
        {
          "id": "res-10",
          "productId": "residential",
          "name": "Team",
          "quantity": 10,
          "unit": "GB",
          "durationDays": null,
          "price": "5.94",
          "pricePerUnit": "0.59",
          "popular": false,
          "features": [
            "Prepaid traffic never expires",
            "Country and city where available",
            "Project credentials and traffic caps"
          ],
          "available": true,
          "countries": null
        }
      ]
    }
  ]
}
```

*curl*

```bash
curl -s "https://africaproxies.com/api/v1/catalog/products"
```

*Python*

```python
import os
import requests

API = "https://africaproxies.com/api/v1"

r = requests.get(f"{API}/catalog/products", timeout=30)
r.raise_for_status()
print(r.json())
```

*Node.js*

```javascript
// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/catalog/products`);
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());
```

## Comprar um plano com o saldo (novo serviço, mais tráfego ou prolongamento de porta)

`POST /v1/orders`

Sempre pago com o saldo pré-pago: a API calcula o preço (preço do catálogo × `quantity`), debita o saldo, cria ou prolonga o serviço e devolve a encomenda como `completed`, com o seu `fulfillment`. As credenciais de proxy ficam disponíveis de imediato.

- **Novo tráfego residencial**: `{ "planId": "res-10" }`.
- **Novo tráfego 4G/5G rotativo (por GB)**: `{ "planId": "mgb-10" }` (subscrição de tráfego com `productId: "mobile-gb"`, entregue em `fulfillment.residentialSubscriptionId`).
- **Adicionar tráfego a uma subscrição existente**: `{ "planId": "res-10", "options": { "subscriptionId": "res_9x2m4k" } }`: o plano tem de pertencer ao produto da subscrição.
- **Novas portas móveis**: `{ "planId": "mob-30d", "quantity": 1, "options": { "country": "AE" } }`, opcionalmente com `carrier` (consulte os operadores de um país em [Portas móveis](/pt/docs/api/mobile/)). Os planos de zona cobrem apenas os países da respetiva zona (caso contrário, `422` em `options.country`).
- **Prolongar uma porta móvel**: `{ "planId": "mob-7d", "options": { "portId": "mob_2v8k1q" } }` acrescenta a duração do plano a `expiresAt`.

**Saldo insuficiente → `402 insufficient_balance`**, com o montante em falta e um carregamento sugerido em `error.details` (`missing`, `suggestedTopUp`). Nenhum erro origina um débito. Para pagar a diferença, inicie um carregamento com o mesmo pedido em `purchase` (`POST /v1/topups`): o plano é comprado assim que o carregamento é creditado.

Autenticação: API chave no cabeçalho `Authorization: Bearer API_KEY`.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- | --- |
| `Idempotency-Key` | header | string | Não | Chave única (por exemplo, um UUID) para repetir um POST com segurança. Conservada durante 24 h. — máx. 128 caracteres |

**Corpo da requisição**

| Campo | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `planId` | string | Sim | — |
| `quantity` | integer | Não | 1–100, predefinição `1` |
| `options` | object | Não | — |

*Exemplo: Residencial*

```json
{
  "planId": "res-10"
}
```

*Exemplo: Portas móveis*

```json
{
  "planId": "mob-30d",
  "quantity": 1,
  "options": {
    "country": "AE",
    "carrier": "etisalat",
    "autoRenew": true
  }
}
```

*Exemplo: Prolongar porta*

```json
{
  "planId": "mob-7d",
  "options": {
    "portId": "mob_2v8k1q"
  }
}
```

*Exemplo: Tráfego móvel*

```json
{
  "planId": "mgb-10"
}
```

*Exemplo: Porta de zona*

```json
{
  "planId": "mob-30d",
  "options": {
    "country": "AE",
    "carrier": "etisalat"
  }
}
```

**Resposta** `201 Created`

```json
{
  "id": "ord_4f8k2m9q",
  "status": "completed",
  "productId": "residential",
  "planId": "res-10",
  "planName": "Team",
  "quantity": 1,
  "unitPrice": "5.94",
  "subtotal": "5.94",
  "discount": "0.00",
  "total": "5.94",
  "promoCode": null,
  "currency": "USD",
  "topUpId": null,
  "options": {},
  "fulfillment": {
    "residentialSubscriptionId": "res_9x2m4k",
    "mobilePortIds": []
  },
  "createdAt": "2026-10-05T14:03:11Z",
  "paidAt": "2026-10-05T14:03:11Z"
}
```

*curl*

```bash
curl -s -X POST "https://africaproxies.com/api/v1/orders" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"planId":"res-10"}'
```

*Python*

```python
import os, uuid
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}", "Idempotency-Key": str(uuid.uuid4())}

r = requests.post(f"{API}/orders", headers=HEADERS, json={"planId": "res-10"}, timeout=30)
r.raise_for_status()
print(r.json())
```

*Node.js*

```javascript
// Node.js 18+ (built-in fetch), ES module
import { randomUUID } from 'node:crypto';

const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/orders`, {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.API_KEY}`, 'Idempotency-Key': randomUUID(), 'Content-Type': 'application/json' },
  body: JSON.stringify({ planId: 'res-10' }),
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());
```

## Listar encomendas

`GET /v1/orders`

Autenticação: API chave no cabeçalho `Authorization: Bearer API_KEY`.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- | --- |
| `page` | query | integer | Não | ≥ 1, predefinição `1` |
| `perPage` | query | integer | Não | 1–100, predefinição `20` |
| `status` | query | `completed` · `cancelled` | Não | As encomendas são criadas já pagas (com débito do saldo). `completed` — paga e entregue (credenciais disponíveis de imediato). |
| `productId` | query | string | Não | Identificador do produto no catálogo. Valores de AfricaProxies: `residential` (GB), `mobile` (portas 4G/5G dedicadas) e `mobile-gb` (tráfego 4G/5G rotativo por GB). Os clientes devem aceitar valores desconhecidos. |

**Resposta** `200 OK`

```json
{
  "data": [
    {
      "id": "ord_4f8k2m9q",
      "status": "completed",
      "productId": "residential",
      "planId": "res-10",
      "planName": "Team",
      "quantity": 1,
      "unitPrice": "5.94",
      "subtotal": "5.94",
      "discount": "0.00",
      "total": "5.94",
      "promoCode": null,
      "currency": "USD",
      "topUpId": null,
      "options": {},
      "fulfillment": {
        "residentialSubscriptionId": "res_9x2m4k",
        "mobilePortIds": []
      },
      "createdAt": "2026-10-05T14:03:11Z",
      "paidAt": "2026-10-05T14:03:11Z"
    }
  ],
  "pagination": {
    "page": 1,
    "perPage": 20,
    "total": 1,
    "totalPages": 1
  }
}
```

*curl*

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

*Python*

```python
import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/orders", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())
```

*Node.js*

```javascript
// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/orders`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());
```

## Obter uma encomenda

`GET /v1/orders/{orderId}`

Autenticação: API chave no cabeçalho `Authorization: Bearer API_KEY`.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- | --- |
| `orderId` | path | string | Sim | — |

**Resposta** `200 OK`

```json
{
  "id": "ord_4f8k2m9q",
  "status": "completed",
  "productId": "residential",
  "planId": "res-10",
  "planName": "Team",
  "quantity": 1,
  "unitPrice": "5.94",
  "subtotal": "5.94",
  "discount": "0.00",
  "total": "5.94",
  "promoCode": null,
  "currency": "USD",
  "topUpId": null,
  "options": {},
  "fulfillment": {
    "residentialSubscriptionId": "res_9x2m4k",
    "mobilePortIds": []
  },
  "createdAt": "2026-10-05T14:03:11Z",
  "paidAt": "2026-10-05T14:03:11Z"
}
```

*curl*

```bash
curl -s "https://africaproxies.com/api/v1/orders/ord_4f8k2m9q" \
  -H "Authorization: Bearer $API_KEY"
```

*Python*

```python
import os
import requests

API = "https://africaproxies.com/api/v1"
HEADERS = {"Authorization": f"Bearer {os.environ['API_KEY']}"}

r = requests.get(f"{API}/orders/ord_4f8k2m9q", headers=HEADERS, timeout=30)
r.raise_for_status()
print(r.json())
```

*Node.js*

```javascript
// Node.js 18+ (built-in fetch), ES module
const API = 'https://africaproxies.com/api/v1';

const res = await fetch(`${API}/orders/ord_4f8k2m9q`, {
  headers: { Authorization: `Bearer ${process.env.API_KEY}` },
});
if (!res.ok) throw new Error((await res.json()).error?.message ?? `HTTP ${res.status}`);
console.log(await res.json());
```

---

AfricaProxies: AfricaProxies é um fornecedor de proxies residenciais para a África Subsaariana, com pagamento em cripto e sem envio de documento de identificação.