> For the complete documentation index, see [llms.txt](https://developers.oxylabs.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.oxylabs.io/products/pt-br/proxies/residential-proxies/public-api.md).

# Public API

Gerencie programaticamente subusuários de Residential Proxy, defina limites de tráfego e acompanhe estatísticas de uso com a Public API.

O [**Public API**](https://residential-api.oxylabs.io/v2/docs) permite que você **gerencie usuários de proxy programaticamente** (por meio da interface RESTful `https://residential-api.oxylabs.io/v2`) sem usar o painel. Você pode criar, excluir e modificar subusuários de proxy, definir limites de uso de tráfego e ver o uso atual e histórico de tráfego.

### Caminhos de API disponíveis

Endpoint base:

```
https://residential-api.oxylabs.io/v2
```

<table data-full-width="false"><thead><tr><th width="78.15625">Método</th><th width="406.92578125">Caminho</th><th>Descrição</th></tr></thead><tbody><tr><td><mark style="color:$success;">POST</mark></td><td><code>/login</code></td><td>Autentique-se para obter o token de acesso (JWT).</td></tr><tr><td><mark style="color:azul;">GET</mark></td><td><code>/users/{userId}/sub-users</code></td><td>Recuperar todos os subusuários ativos</td></tr><tr><td><mark style="color:$success;">POST</mark></td><td><code>/users/{userId}/sub-users</code></td><td>Criar um novo subusuário.</td></tr><tr><td><mark style="color:azul;">GET</mark></td><td><code>/users/{userId}/sub-users/{subUserId}</code></td><td>Recuperar estatísticas de uso de tráfego para um subusuário específico.</td></tr><tr><td><mark style="color:$primary;">PATCH</mark></td><td><code>/users/{userId}/sub-users/{subUserId}</code></td><td>Modificar um subusuário.</td></tr><tr><td><mark style="color:vermelho;">DELETE</mark></td><td><code>/users/{userId}/sub-users/{subUserId}</code></td><td>Excluir um subusuário.</td></tr><tr><td><mark style="color:azul;">GET</mark></td><td><code>/users/{userId}/sub-users/{subUserId}/target-stats</code></td><td>Obter o uso de tráfego do subusuário por domínio de destino (últimos 30 dias, requer data específica).</td></tr><tr><td><mark style="color:azul;">GET</mark></td><td><code>/users/{userId}/client-stats</code></td><td>Recuperar o uso total de tráfego do mês atual.</td></tr></tbody></table>

### Fluxo de autenticação e uso

Todas as requisições da API (exceto `/login`) exigem um JSON Web Token (JWT) passado no `Authorization: Bearer {token}` cabeçalho HTTP.

{% hint style="info" %}
O `login` endpoint requer as credenciais do seu Usuário Principal (o primeiro subusuário na lista de usuários do painel). Se você alterou recentemente a senha do usuário principal, use a senha original ou [entre em contato com o suporte](mailto:support@oxylabs.io).&#x20;
{% endhint %}

{% hint style="warning" %}
O token de acesso JWT gerado expira em 1 hora. Após a expiração, você deve solicitar um novo token via `POST /login`.
{% endhint %}

{% stepper %}
{% step %}

### Gerar token de acesso JWT

Autentique-se via `POST /login` usando Autenticação Básica HTTP com as credenciais do seu usuário principal (codificadas em base64).

```bash
curl -X "POST" \
  "https://residential-api.oxylabs.io/v2/login" \
  -H "accept: application/json" \
  -u "MAIN_USERNAME:MAIN_PASSWORD"
```

A resposta inclui dois valores-chave:

```json
{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}
```

Salve o `user_id` e `token` retornados para todas as requisições subsequentes.
{% endstep %}

{% step %}

### Faça requisições autenticadas à API

Inclua o JWT no `Authorization: Bearer {token}` cabeçalho e passe seu `user_id` na rota da requisição para consultar a API e gerenciar usuários e verificar estatísticas.

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X "GET" \
  "https://residential-api.oxylabs.io/v2/users/YOUR_USER_ID/client-stats" \
  -H "accept: application/json" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

user_id = "00000000-0000-0000-0000-000000000000"
jwt_token = "YOUR_JWT_TOKEN"

url = f"https://residential-api.oxylabs.io/v2/users/{user_id}/client-stats"
headers = {
    "accept": "application/json",
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(url, headers=headers)
print(response.json())
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
const axios = require('axios');

const userId = '00000000-0000-0000-0000-000000000000';
const jwtToken = 'YOUR_JWT_TOKEN';

axios.get(`https://residential-api.oxylabs.io/v2/users/${userId}/client-stats`, {
  headers: {
    'accept': 'application/json',
    'Authorization': `Bearer ${jwtToken}`
  }
})
.then(response => console.log(response.data))
.catch(error => console.error(error));
```

{% endtab %}
{% endtabs %}

#### Exemplo de saída

```json
{
  "traffic": 1.2354839,
  "date_from": "2026-09-01",
  "date_to": "2026-09-14"
}
```

{% endstep %}
{% endstepper %}

### Configuração da entrada Backconnect (CNAME)

Para rotear o tráfego de proxy pelo seu nome de domínio personalizado em vez de `pr.oxylabs.io`, configure um registro DNS `CNAME` no gerenciador do seu provedor de DNS.

1. Crie um novo `CNAME` registro no seu provedor de DNS (por exemplo, Cloudflare, Route 53).
2. Defina o hostname/subdomínio (por exemplo, `entry.yourdomain.com`) como destino `pr.oxylabs.io`.
3. Use o nome de domínio personalizado no lugar de `pr.oxylabs.io` em todas as strings de conexão de requisição de proxy.

![Backconnect](https://1795063165-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBQ7Zf9paoN3FTeGcyfY1%2Fuploads%2Fgit-blob-9d15ff608e52a76e6d288eb45c3bd648ddf970ef%2Fcname.jpg?alt=media)

Para mais informações, entre em contato [**com o Suporte ao cliente**](mailto:support@oxylabs.io) ou com o seu gerente de conta.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developers.oxylabs.io/products/pt-br/proxies/residential-proxies/public-api.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.