Перейти к содержимому
Справочник API
/
/
/
Добавление прокси

Добавление прокси

Request

Создаёт конфигурацию прокси в команде.

  • Предварительные условия: proxyPort обязателен и должен быть в диапазоне 1–65535, а proxyProvider должен быть распознаваемым провайдером.
  • Эффект: вставляет запись прокси и возвращает её идентификатор, готовый для привязки к профилям. Поставщику прокси ничего не отправляется.
  • Завершение: синхронное.
  • Повтор: проверки уникальности имени или конфигурации нет. Отправка одного и того же тела дважды создаст два прокси с двумя идентификаторами. После таймаута сначала поищите запись в /proxyInfo/page, а затем решайте, отправлять ли повторно.

Задокументированные бизнес-ошибки: 14023. Значения кодов см. в Error Codes. Любая операция может дополнительно вернуть общие коды.

Bodyapplication/jsonrequired
citystring

Город

Example:""
countrystring

Код страны (ISO 3166-1 alpha-2). Требуется только если proxyProvider=17.

Example:"AD"
encryptionTypeinteger, (int32)

Тип шифрования, допустимые значения — целые числа от 1 до 14.

Example:14
ipChangeActioninteger, (int32)

Действие при изменении IP-адреса: 0 = Блокировка, 1 = Предупреждение

Example:1
ipMonitorboolean

Включить мониторинг изменений IP-адреса

Example:false
passwordstring

Пароль для аутентификации прокси-сервера

Example:""
proxyIpstringrequired

IP-адрес прокси

Example:"8.10.22.46"
proxyNamestring

Имя прокси (поддерживает заполнители, например, {{random}})

Example:"sock5_{{random}}"
proxyPortinteger, (int32)required

Номер порта прокси

Example:65534
proxyProviderinteger, (int32)required

Тип прокси-провайдера: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH, 4=Oxylabs, 5=Proxys.io, 6=GeoSurf, 7=Luminati, 8=Lumauto, 9=Oxylabsauto, 10=Trojan, 11=Shadowsocks, 12=vmess, 13=ABCPROXY, 14=LunaProxy, 15=IPHTML, 16=PiaProxy, 17=922S5. Особые правила:

  • Если proxyProvider равен 7 или 8, proxyType обязателен.

  • Если proxyProvider равен 17, country обязателен; state и city необязательны.

Example:2
proxyTypeinteger, (int32)

Тип протокола прокси: 0=HTTP, 1=HTTPS, 2=SOCKS5, 3=SSH. Требуется только при значении proxyProvider 7 или 8.

Example:1
refreshUrlstring

URL для обновления IP-адреса динамического прокси (если поддерживается)

Example:""
statestring

Штат/Провинция

Example:""
usernamestring

Имя пользователя для аутентификации через прокси-сервер

Example:""
POST
/api/proxyInfo/add
curl -i -X POST \
  http://127.0.0.1:40000/api/proxyInfo/add \
  -H 'Content-Type: application/json' \
  -d '{
    "proxyIp": "8.10.22.46",
    "proxyPort": 65534,
    "proxyProvider": 2,
    "proxyType": 1,
    "country": "AD",
    "state": "",
    "city": "",
    "encryptionType": 14,
    "ipChangeAction": 1,
    "ipMonitor": false,
    "proxyName": "sock5_{{random}}",
    "refreshUrl": "",
    "username": "",
    "password": ""
  }'

Responses

Успех. data — одно значение типа integer.

Headers
any
Bodyapplication/json
codeintegerrequired

Возвращаемый код результата 0: Нормальный. Остальные коды являются исключениями.

msgstring or nullrequired

Сообщение об ошибке

dataintegerrequired

Идентификатор прокси

requestIdstringrequired

Идентификатор запроса на операцию

Response
{
  "code": 0,
  "msg": "",
  "data": 0,
  "requestId": "abcd1234"
}