Public API

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

El 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

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

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

Método

Ruta

Descripción

POST

/login

Autentíquese 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 (disponibles 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 mediante 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 Authorize .

Luego, introduzca las credenciales de su usuario proxy principal en la ventana recién abierta y seleccione Authorize 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 autorizar, vaya a la pestaña POST /login para generar el JSON Web Token (JWT) que se requiere para finalizar la autorización.

Luego, seleccione Try it out → Execute. Guarde los valores de user_id y token 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 resolverlo, 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 Authorization de nuevo y pegue el token del paso anterior en el campo de autenticación JWT Token. Luego, haga clic en el botón Authorize para guardar.

4. Pruebe la Public API

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

Inicie sesión y genere JWT

Use la 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.

Endpoint: 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 del usuario requerido para las solicitudes de API.
token es el JSON Web Token (JWT) requerido para una 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 comprobar 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 añadir un registro DNS CNAME con pr.oxylabs.io como destino. Así se ve esta configuración en el gestor DNS de Cloudflare para el subdominio de entrada:

Para más información, póngase en contacto con support@oxylabs.io o con su gestor de cuenta.

AnteriorObjetivos restringidos SiguienteCódigos de respuesta

¿Te fue útil?

Buenas tardes

Rutas disponibles

Cómo usar la Public API

1. Autorice a su usuario principal

2. Inicie sesión para generar JWT

3. Finalice la autorización con JWT

4. Pruebe la Public API

Inicie sesión y genere JWT

Use el token y user_id con solicitudes

IPs de entrada de Backonnect

Use el `token` y `user_id` con solicitudes