Documentation has been updated: Find all product details, Web Scraper API targets, and integrations in their dedicated sections
Ctrlk
Access Oxylabs dashboard

Public API

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

A Public API permite que você gerencie usuários 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 para Mobile Proxies.

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 destino para um subusuário. Requer que você especifique uma data (últimos 30 dias disponíveis).

GET

/users/{userId}/client-stats

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

Como usar a Public API

Teste pela interface web

1. Autorize seu usuário principal

Se você estiver testando a funcionalidade pela Public API interface, clique no botão Authorize .

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

O usuário principal é o primeiro subusuário na sua lista de usuários.

2. Faça login para gerar JWT

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

Depois, selecione Try it out → Execute. Salve os valores user_id e token para uso posterior.

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

Se você tiver alterado recentemente a senha do seu usuário principal, você receberá um erro. Para resolver isso, você deve usar sua senha original ou entrar em contato com nossa equipe de Suporte 24/7 via chat ao vivo ou e-mail.

3. Finalize a autorização com JWT

Abra a janela Authorization novamente e cole o token da etapa anterior no campo de autenticação JWT Token. Em seguida, clique no botão Authorize para salvar.

4. Teste a Public API

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

1

Faça login e gere JWT

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

O usuário principal é o primeiro subusuário na sua lista de usuários.

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

Cabeçalho: Authorization: Basic base64(username:password)

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

Se você tiver alterado recentemente a senha do seu usuário principal, você receberá um erro. Para resolver isso, você deve usar sua senha original ou entrar em contato com nossa equipe de Suporte 24/7 via chat ao vivo ou e-mail.

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

  • user_id é o identificador exclusivo do usuário necessário para solicitações da API.

  • token é o JSON Web Token (JWT) necessário para autorização posterior.

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

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

2

Use o token e user_id com solicitações

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

Cabeçalho: 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}"
Exemplo de saída
{
  "traffic": 1.2354839,
  "date_from": "2026-01-01",
  "date_to": "2026-01-15"
}

IPs de entrada do Backonnect

Se você quiser usar o nome DNS do seu próprio 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 destino. Veja como essa configuração aparece no gerenciador de DNS da Cloudflare para subdomínio de entrada:

Backconnect

Para mais informações, entre em contato com support@oxylabs.io ou com seu gerente de conta.

AnteriorDestinos restritosPróximoCódigos de resposta

Isto foi útil?