Public API

Gestiona programáticamente los subusuarios de Residential Proxy, establece límites de tráfico y sigue las estadísticas de uso con la Public API.

La Public API le permite administrar usuarios proxy programáticamente sin usar el panel. Puede crear, eliminar y modificar subusuarios proxy, establecer límites de uso de tráfico y ver el uso de tráfico actual e histórico.

Rutas disponibles

Punto final base: https://residential-api.oxylabs.io/v2

Combine el punto final base con la ruta para realizar acciones específicas:

Método

Ruta

Descripción

POST

/login

Autenticarse para obtener el token de acceso (JWT).

GET

/users/{userId}/sub-users

Recuperar todos los subusuarios activos

POST

/users/{userId}/sub-users

Crear un nuevo subusuario.

GET

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

Recuperar estadísticas de uso de tráfico para un subusuario específico.

PATCH

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

Modificar un subusuario.

DELETE

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

Eliminar un subusuario.

GET

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

Recuperar estadísticas de uso de tráfico por destino para un subusuario. Requiere especificar una fecha (disponible para los últimos 30 días).

GET

/users/{userId}/client-stats

Recuperar el uso total de tráfico del mes actual.

Cómo usar la Public API

Pruebas a través de la interfaz web

1. Autorice a su usuario principal

Si está probando la funcionalidad a través de la Public API interfaz, haga clic en el botón Autorizar .

A continuación, introduzca las credenciales de su usuario proxy principal en la ventana que se abre y seleccione Autorizar una vez más.

El usuario principal es el primer subusuario en su lista de usuarios.

2. Inicie sesión para generar JWT

Después de la autorización, vaya a la POST /login pestaña para generar el token web JSON (JWT) que se requiere para finalizar la autorización.

Luego, seleccione Probar → Ejecutar. Guarde los user_id y token valores para usarlos más adelante.

El JWT expira en 1 hora. Después de eso, deberá generar uno nuevo.

Si ha cambiado recientemente la contraseña de su usuario principal, recibirá un error. Para solucionarlo, debe usar su contraseña original o contactar a nuestro equipo de soporte 24/7 a través de chat en vivo o correo electrónico.

3. Finalice la autorización con JWT

Abra la ventana de Autorización de nuevo y pegue el token del paso anterior en el campo de autenticación JWT Token. Luego, haga clic en el Autorizar botón para guardar.

4. Pruebe la Public API

Ahora puede probar los endpoints de Public API en su navegador. Para cada endpoint, deberá ingresar el user_id, obtenido en el Paso 2.

Inicie sesión y genere JWT

Use Autenticación Básica para iniciar sesión con las credenciales de su usuario principal (codificadas en base64) y recibir un token JWT.

El usuario principal es el primer subusuario en su lista de usuarios.

Punto final: https://residential-api.oxylabs.io/v2/login

Encabezado: Authorization: Basic base64(username:password)

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

Una vez ejecutado, el servidor responderá con dos valores importantes necesarios para los pasos posteriores:

user_id es el identificador único de usuario requerido para las solicitudes de API.
token es el token web JSON (JWT) requerido para la autorización posterior.

Ejemplo de salida:

{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "example token"
}

El JWT expira en 1 hora. Después de eso, deberá generar uno nuevo.

Use el `token` y `user_id` con solicitudes

Ahora puede consultar la API para administrar usuarios y verificar estadísticas. Todas las solicitudes posteriores requieren el JWT token y su user_id.

Encabezado: Authorization: Bearer {token}

Por ejemplo, comprobemos el uso total de tráfico del mes actual.

curl -X "GET" \\
  "https://residential-api.oxylabs.io/v2/users/{userId}/client-stats" \\
  -H "accept: application/json" \\
  -H "Authorization: Bearer {token}"

Ejemplo de salida

{
  "traffic": 1.2354839,
  "date_from": "2026-01-01",
  "date_to": "2026-01-15"
}

IPs de entrada de Backonnect

Si desea usar el nombre DNS de su propio nodo de entrada backconnect, puede apuntar su subdominio/dominio a nuestro nodo de entrada. Para hacerlo, debe agregar un registro DNS CNAME con pr.oxylabs.io como destino. Así es como se ve una configuración de este tipo en el administrador DNS de Cloudflare para entrada subdominio: