Ir al contenido principal

Gestionar una lista residencial

Renombra una lista residencial, cambia su rotación o elimínala a través de la API.

Esta guía muestra cómo renombrar una lista residencial, cambiar su rotación o eliminarla.

Cada solicitud usa tu clave API personal del panel de tu cuenta (cómo obtener tu clave API). En los ejemplos siguientes, reemplaza YOUR_API_KEY por tu propia clave. Para pagar con el saldo de tu cuenta, usa paymentId = 1.

Paso 1 — Lista las listas residenciales

Lista tus listas residenciales y copia el id de la que quieras gestionar.

Endpoint

GET https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/lists

Respuesta

{
  "status": "success",
  "data": [
    { "id": 561, "title": "US Washington", "login": "3c8aa1d4", "rotation": 60 }
  ],
  "errors": []
}

Paso 2 — Renombra la lista

Renombra la lista por su id y un nuevo title.

Endpoint

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/rename

Cuerpo de la solicitud

Nombre

Tipo

Descripción

id

Number

ID de la lista.

title

String

El nuevo nombre de la lista.

Respuesta

{
  "status": "success",
  "data": { "id": 561, "title": "New name" },
  "errors": []
}

Paso 3 — Cambia la rotación

O cambia la rotación de la lista por su id.

Endpoint

POST https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/rotation

Cuerpo de la solicitud

Nombre

Tipo

Descripción

id

Number

ID de la lista.

rotation

Number

Rotación: -1 = sticky, 0 = por solicitud, 1..3600 = segundos.

Respuesta

{
  "status": "success",
  "data": { "id": 561, "title": "New name" },
  "errors": []
}

Paso 4 — O elimina la lista

Elimina la lista por su id. Es irreversible.

Endpoint

DELETE https://proxy-seller.com/personal/api/v1/YOUR_API_KEY/resident/list/delete

Cuerpo de la solicitud

Nombre

Tipo

Descripción

id

Number

ID de la lista.

Respuesta

{
  "status": "success",
  "data": { "deleted": true },
  "errors": []
}

Referencia completa de la API

¿Ha quedado contestada tu pregunta?