search
Painel OxylabsFale conosco

Public API

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

O Public APIarrow-up-right permite que você gerencie usuários de proxy programaticamente sem usar o painel. Você pode criar, excluir e modificar subusuários de proxy, definir limites de uso de tráfego e visualizar o uso de tráfego atual e histórico.

hashtag
Caminhos disponíveis

Endpoint base: https://residential-api.oxylabs.io/v2

Combine o endpoint base com o caminho para executar ações específicas:

Método
Caminho
Descrição

POST

/login

Autentique-se para obter o token de acesso (JWT).

GET

/users/{userId}/sub-users

Recuperar todos os subusuários ativos

POST

/users/{userId}/sub-users

Criar um novo subusuário.

GET

/users/{userId}/sub-users/{subUserId}

Recuperar estatísticas de uso de tráfego para um subusuário específico.

PATCH

/users/{userId}/sub-users/{subUserId}

Modificar um subusuário.

DELETE

/users/{userId}/sub-users/{subUserId}

Excluir um subusuário.

GET

/users/{userId}/sub-users/{subUserId}/target-stats

Recuperar estatísticas de uso de tráfego por alvo para um subusuário. Requer que você especifique uma data (últimos 30 dias disponíveis).

GET

/users/{userId}/client-stats

Recuperar uso total de tráfego do mês atual.

hashtag
Como usar o Public API

chevron-rightTestando pela interface webhashtag

hashtag
1. Autorize seu usuário principal

Se você estiver testando a funcionalidade através da Public APIarrow-up-right interface, clique no Authorize botão.

Em seguida, insira as credenciais do seu usuário principal de proxy na janela recém-aberta e selecione Authorize mais uma vez.

circle-info

O usuário principal é o primeiro subusuário na sua lista de usuáriosarrow-up-right.

hashtag
2. Faça login para gerar o JWT

Após a autorização, navegue até a POST /login aba para gerar o JSON Web Token (JWT) necessário para finalizar a autorização.

Então, selecione Try it out → Execute. Salve o user_id e token valores para uso posterior.

circle-exclamation

O JWT expira em 1 hora. Depois disso, você precisará gerar um novo.

circle-exclamation

Se você alterou a senha do seu usuário principal recentemente, receberá um erro. Para resolver isso, você deve usar sua senha original ou contatar nossa Equipe de Suporte 24/7 via chat ao vivo arrow-up-rightou emailenvelope.

hashtag
3. Finalize a autorização com o JWT

Abra a Authorization janela novamente e cole o token do passo anterior no campo de autenticação JWT Token. Então, clique no Authorize botão para salvar.

hashtag
4. Teste o Public API

Agora você pode testar os endpoints do Public API no seu navegador. Para cada endpoint, você precisará inserir o user_id, obtido no Passo 2.

1

hashtag
Faça login e gere o JWT

Use a Autenticação Básica para entrar com as credenciais do seu usuário principal (codificadas em base64) para receber um token JWT.

circle-info

O usuário principal é o primeiro subusuário na sua lista de usuáriosarrow-up-right.

Endpoint: https://residential-api.oxylabs.io/v2/login

Header: Authorization: Basic base64(username:password)

curl -X "POST" \
  "https://residential-api.oxylabs.io/v2/login" \
  -H "accept: application/json" \
  -u "USERNAME:PASSWORD"
circle-exclamation

Se você alterou a senha do seu usuário principal recentemente, receberá um erro. Para resolver isso, você deve usar sua senha original ou contatar nossa Equipe de Suporte 24/7 via chat ao vivo arrow-up-rightou emailenvelope.

Uma vez executado, o servidor responderá com dois valores importantes necessários para passos posteriores:

  • user_id é o identificador único do usuário exigido para requisições da API.

  • token é o JSON Web Token (JWT) exigido para autorização adicional.

Exemplo de saída:
{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "example token"
}
circle-exclamation

O JWT expira em 1 hora. Depois disso, você precisará gerar um novo.

2

hashtag
Use o token e user_id com as requisições

Agora você pode consultar a API para gerenciar usuários e verificar estatísticas. Todas as requisições subsequentes exigem o JWT token e seu user_id.

Header: Authorization: Bearer {token}

Por exemplo, vamos verificar o uso total de tráfego do mês atual.

curl -X "GET" \
  "https://residential-api.oxylabs.io/v2/users/{userId}/client-stats" \
  -H "accept: application/json" \
  -H "Authorization: Bearer {token}"
chevron-rightAmostra de saídahashtag
{
  "traffic": 1.2354839,
  "date_from": "2026-01-01",
  "date_to": "2026-01-15"
}

hashtag
IPs de entrada Backonnect

Se você quiser usar seu próprio nome DNS de nó de entrada backconnect, você pode apontar seu subdomínio/domínio para nosso nó de entrada. Para fazer isso, você precisa adicionar um registro DNS CNAME com pr.oxylabs.io como alvo. É assim que essa configuração aparece no gerenciador de DNS do Cloudflare para entrada subdomínio:

Backconnect

Para mais informações, entre em contato com [email protected]envelope ou seu gerente de conta.

AnteriorAlvos restritosPróximoCódigos de resposta

Atualizado

Isto foi útil?