Ir para conteúdo principal

Gerenciar uma lista residencial

Renomeie uma lista residencial, altere a rotação ou exclua-a pela API.

Este guia mostra como renomear uma lista residencial, alterar sua rotação ou excluí-la.

Cada requisição usa sua chave de API pessoal do painel da sua conta (como obter sua chave de API). Nos exemplos abaixo, substitua YOUR_API_KEY pela sua própria chave. Para pagar com o saldo da conta, use paymentId = 1.

Passo 1 — Liste as listas residenciais

Liste suas listas residenciais e copie o id da que deseja gerenciar.

Endpoint

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

Resposta

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

Passo 2 — Renomeie a lista

Renomeie a lista pelo seu id e um novo title.

Endpoint

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

Corpo da requisição

Nome

Tipo

Descrição

id

Number

ID da lista.

title

String

O novo nome da lista.

Resposta

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

Passo 3 — Altere a rotação

Ou altere a rotação da lista pelo seu id.

Endpoint

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

Corpo da requisição

Nome

Tipo

Descrição

id

Number

ID da lista.

rotation

Number

Rotação: -1 = sticky, 0 = por requisição, 1..3600 = segundos.

Resposta

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

Passo 4 — Ou exclua a lista

Exclua a lista pelo seu id. É irreversível.

Endpoint

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

Corpo da requisição

Nome

Tipo

Descrição

id

Number

ID da lista.

Resposta

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

Referência completa da API

Isto respondeu à sua pergunta?