Public API

Gestiona programáticamente sub‑usuarios de Residential Proxy, establece límites de tráfico y realiza seguimiento de estadísticas de uso con la Public API.

El Public API te permite gestionar usuarios de proxy programáticamente sin usar el panel. Puedes crear, eliminar y modificar subusuarios de 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

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

Método

Ruta

Descripción

POST

/login

Autentícate 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 objetivo para un subusuario. Requiere que especifiques 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 a través de la interfaz web

1. Autorizar a tu usuario principal

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

A continuación, introduce las credenciales de tu usuario principal de proxy en la ventana que se abrió y selecciona Autorizar una vez más.

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

2. Iniciar sesión para generar el JWT

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

Luego, selecciona Probar → Ejecutar. Guarda el user_id y token valores para usarlos más tarde.

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

Si has cambiado la contraseña de tu usuario principal recientemente, recibirás un error. Para solucionarlo, debes usar tu contraseña original o contactar a nuestro equipo de soporte 24/7 vía chat en vivo o correo electrónico.

3. Finalizar la autorización con JWT

Abre la Ventana de Authorization otra vez y pega el token del paso anterior en el campo de autenticación JWT Token. Luego, haz clic en el Autorizar botón para guardar.

4. Probar la Public API

Ahora puedes probar los endpoints de la Public API en tu navegador. Para cada endpoint, necesitarás ingresar el user_id, obtenido en el Paso 2.

Inicia sesión y genera el JWT

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

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

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

Cabecera: 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 requeridos para pasos posteriores:

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

Ejemplo de salida:

{
  "user_id": "00000000-0000-0000-0000-000000000000",
  "token": "ejemplo de token"
}

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

Usa el `token` y `user_id` con las solicitudes

Ahora puedes consultar la API para gestionar usuarios y verificar estadísticas. Todas las solicitudes posteriores requieren el JWT token y tu user_id.

Cabecera: Authorization: Bearer {token}

Por ejemplo, revisemos 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}"

Muestra de salida

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

IPs de entrada Backonnect

Si quieres usar tu propio nombre DNS de nodo de entrada backconnect, puedes apuntar tu subdominio/dominio a nuestro nodo de entrada. Para hacerlo, necesitas agregar un registro DNS CNAME con pr.oxylabs.io como destino. Así es como se ve dicha configuración en el administrador DNS de Cloudflare para entrada subdominio:

Para más información, por favor contacta a [email protected] o a tu gestor de cuenta.

AnteriorObjetivos restringidos SiguienteCódigos de respuesta

Última actualización hace 23 días

¿Te fue útil?

Buenas tardes

hashtagRutas disponibles

hashtagCómo usar la Public API

hashtag1. Autorizar a tu usuario principal

hashtag2. Iniciar sesión para generar el JWT

hashtag3. Finalizar la autorización con JWT

hashtag4. Probar la Public API

hashtagInicia sesión y genera el JWT

hashtagUsa el token y user_id con las solicitudes

hashtagIPs de entrada Backonnect

Rutas disponibles

Cómo usar la Public API

1. Autorizar a tu usuario principal

2. Iniciar sesión para generar el JWT

3. Finalizar la autorización con JWT

4. Probar la Public API

Inicia sesión y genera el JWT

Usa el `token` y `user_id` con las solicitudes

IPs de entrada Backonnect