Обращение к API производится по адресу:
https://proxy-store.com/api/{api_key}/{method}/?{params}
api_key
Секретный ключ, вы можете получить его в личном кабинете
method
Название одного из методов
params
Дополнительные параметры запроса в зависимости от метода
Любые расходы списываются с баланса Личного кабинета!
Доступные методы:
getbalance
Получение баланса на счете
getcategory
Получение списка категорий
getprice
Получение информации о сумме заказа
getcount
Получение информации о доступном кол-ве прокси для конкретной страны
getcountry
Получение списка доступных стран
getproxy
Получение списка ваших прокси
settype
Изменение типа (протокола) прокси
setdescr
Обновление технического комментария
buy
Покупка прокси
prolong
Продление списка прокси
autoprolong
Включение и выключение автопродления прокси
delete
Удаление прокси
setipauth
IP авторизации для прокси
check
Проверка валидности прокси
При обращении к любому методу api, в ответе всегда будет присутствовать status:
Успешный ответ:
{
"status": "ok"
}
status
Всегда "ok", если успешный ответ и не возникло ошибок
Ошибочный ответ:
{
"status": false,
"error_id": 100,
"error": "Error key"
}
status
Всегда false, если ошибочный ответ
error_id
Номер ошибки
error
Описание ошибки
Метод "getbalance"
Получение баланса на счете
https://proxy-store.com/api/{api_key}/getbalance
Ответ:
{
"status": "ok",
"balance": "100",
"currency": "USD"
}
Метод "getcategory"
Получение списка доступных категорий
Параметры:
nokey
При добавлении данного параметра (nokey=1), список list будет возвращаться без ключей
https://proxy-store.com/api/{api_key}/getcategory?nokey=1
Ответ:
{
"status": "ok",
"list": [
{
"id": "for_al",
"name": "Для всех сайтов"
}
]
}
Метод "getprice"
Используется для получения информации о сумме заказа в зависимости от периода и кол-ва прокси.
Параметры метода:
count
(Обязательный) - Кол-во прокси
period
(Обязательный) - Кол-во дней
category
(Обязательный) - Категория для покупки (из метода getcategory)
country
(Обязательный) - Код страны в формате iso2
https://proxy-store.com/api/{api_key}/getprice?count=100&period=30&category=for_all&country=us
В примере выше мы получаем информацию о стоимости 100 IPv4 прокси на 30 дней.
В случае успешного ответа:
{
"status": "ok",
"price": 1800,
"price_single": 0.6,
"category", "for_all",
"period": 30,
"country": "us",
"count": 100
}
price
Итоговая стоимость
price_single
Стоимость одного прокси
category
Категория прокси
period
Запрошенный период (кол-во дней)
country
Код страны в формате iso2
count
Запрошенное кол-во прокси
Метод "getcount"
Используется для получения информации о доступном для приобретения кол-ве прокси определенной страны. При отсутствии параметров category и country в ответе будет отображено количество прокси по всем странам и категориям
Параметры метода:
country
Код страны в формате iso2
category
Категория для покупки (из метода getcategory)
https://proxy-store.com/api/{api_key}/getcount?country=ru&category=for_all
В примере выше мы получаем информацию о доступном для приобретения кол-ве российских IPv4 прокси.
В случае успешного ответа с параметрами:
{
"status": "ok",
"count": 971,
}
https://proxy-store.com/api/{api_key}/getcount
В примере выше мы получаем прокси по всем доступным странам и категориям
В случае успешного ответа без параметров:
{
"status":"ok",
"count": {
"for_all": {
"ru":18201,
"de":0,
"gb":2974,
"ua":2973,
"us":2787
},
"soc": {
"ru":18561,
"de":865,
"gb":2783,
"ua":2981,
"us":2991
},
...
}
}
count
Доступное кол-во.
Метод "getcountry"
Используется для получения информации о доступных для приобретения странах.
Параметры метода:
category
(Обязательный) - Категория для покупки (из метода getcategory)
https://proxy-store.com/api/{api_key}/getcountry?category=for_all
В случае успешного ответа:
{
"status": "ok",
"list": "["ru","ua","us"]",
}
list
Массив доступных стран в формате iso2.
Метод "getproxy"
Используется для получения списка ваших прокси.
Параметры метода:
state
Состояние возвращаемых прокси. Доступные значения: active - Активные, expiring - Заканчивающиеся, all - Все (по-умолчанию)
order_id
Внутренний номер заказа. Если данный параметр присутствует, то будут выбраны только те прокси, которые были приобретены в рамках этого заказа
comment
Комментарий, который вы указывали для прокси. Если данный параметр присутствует, то будут выбраны только те прокси, у которых присутствует данный комментарий, если же данный параметр не задан, то будут выбраны все прокси
nokey
При добавлении данного параметра (nokey=1), список list будет возвращаться без ключей
https://proxy-store.com/api/{api_key}/getproxy
В случае успешного ответа:
{
"status": "ok",
"list_count": 4,
"list": {
"11": {
"id": 11,
"ip": "185.22.134.250",
"port": "7330",
"user": "5svBNZ",
"pass": "iagn2d",
"type": "http",
"country": "ru",
"date": "2016-06-19 16:32:39",
"date_end": "2016-07-12 11:50:41",
"unixtime": 1466379159,
"unixtime_end": 1468349441,
"comment": "",
"active": 1,
"category": "for_all"
},
"14": {
"id": 14,
"ip": "185.22.134.242",
"port": "7386",
"user": "nV5TFK",
"pass": "3Itr1t",
"type": "http",
"country": "ru",
"date": "2016-06-27 16:06:22",
"date_end": "2016-07-11 16:06:22",
"unixtime": 1466379159,
"unixtime_end": 1468349441,
"comment": "",
"active": 1,
"category": "for_all"
}
}
}
list_count
Кол-во прокси
list
Массив прокси
id
Внутренний номер прокси, необходим для продления срока действия - метод prolong
ip
IPv4
port
Порт
user
Логин
pass
Пароль
type
Тип прокси: http - HTTPS, socks - SOCKS5
country
Страна (iso2)
date
Дата покупки прокси
date_end
Дата окончания срока действия прокси
comment
Комментарий
active
Активный (1) или нет (0)
category
Категория прокси
Метод "setipauth"
Используется для указания IP адресов, с которых можно производить авторизацию на прокси (до 3 шт)
Параметры метода:
ips
Список IP через запятую (до 3 шт)
ids
(Обязательный) - Перечень внутренних номеров прокси в нашей системе, через запятую
https://proxy-store.com/api/{api_key}/setipauth?ids=10,11,12,15&ips=192.168.1.2,192.168.1.5
В примере выше мы изменяем IP авторизаций на 192.168.1.2,192.168.1.5. Чтобы вернуть авторизацию по логину/паролю, укажите пустое значение для ips.
В случае успешного ответа:
{
"status": "ok",
}
Метод "settype"
Используется для изменения типа (протокола) у списка прокси.
Параметры метода:
ids
(Обязательный) - Перечень внутренних номеров прокси в нашей системе, через запятую
type
(Обязательный) - Устанавливаемый тип (протокол): http - HTTPS, либо socks - SOCKS5
https://proxy-store.com/api/{api_key}/settype?ids=10,11,12,15&type=socks
В примере выше мы изменяем тип прокси с номерами 10,11,12,15 на SOCKS5.
В случае успешного ответа:
{
"status": "ok"
}
Метод "setdescr"
Используется для обновления технического комментария у списка прокси, который был установлен при покупке (метод buy).
Параметры метода:
comment
(Обязательный) - новый комментарий. Максимальная длина 50 символов
old_comment
Технический комментарий, который нужно изменить
ids
Перечень внутренних номеров прокси в нашей системе, через запятую
Обязательно должен присутствовать один из параметров, либо ids либо old_comment
https://proxy-store.com/api/{api_key}/setdescr?old_comment=test&comment=newtest
В примере выше мы изменяем комментарий с test на newtest
В случае успешного ответа:
{
"status": "ok",
"count": 4
}
count
Кол-во прокси, у которых был изменен комментарий
Метод "buy"
Используется для покупки прокси.
Параметры метода:
category
(Обязательный) - Категория для покупки (из метода getcategory)
count
(Обязательный) - Кол-во прокси для покупки
period
(Обязательный) - Период на который покупаются прокси - кол-во дней
country
(Обязательный) - Страна в формате iso2
type
Тип прокси (протокол): socks, либо http (по-умолчанию)
comment
Технический комментарий для списка прокси, максимальная длина 50 символов. Указание данного параметра позволит вам делать выборку списка прокси по этому параметру через метод getproxy
username
Логин для авторизации через прокси, 5-15 символов (необязательно)
password
Пароль для авторизации через прокси, 5-15 символов (необязательно)
generate_auth
Генерация логина/пароля: 1 - генерация данных для авторизации, 0 - отключение генерации данных для авторизации через прокси (по-умолчанию)
coupon
Промокод (необязательно)
nokey
При добавлении данного параметра (nokey=1), список list будет возвращаться без ключей
https://proxy-store.com/api/{api_key}/buy?category=for_all&count=1&period=30&country=ru
В примере выше мы покупаем 1 российский IPv4 прокси на 30 дней
В случае успешного ответа:
{
"status": "ok",
"order_id": 100000,
"count": 1,
"price": 6.3,
"price_single": 0.9,
"period": 7,
"country": "ru"
"list": {
"15": {
"id": 15,
"ip": "185.22.134.250",
"port": "7330",
"user": "5svBNZ",
"pass": "iagn2d",
"type": "http",
"country": "ru"
"date": "2016-06-19 16:32:39",
"date_end": "2016-07-12 11:50:41",
"unixtime": 1466379159,
"unixtime_end": 1468349441,
"comment": "",
"active": 1,
"category": "for_all"
}
}
}
order_id
Внутренний номер заказа
count
Запрошенное кол-во прокси для покупки
price
Итоговая стоимость
price_single
Стоимость одного прокси для указанного кол-ва и периода
period
Запрошенный период для покупки (кол-во дней)
country
Локация (страна) прокси для покупки в формате iso2
list
Массив купленных прокси
id
Внутренний номер прокси, необходим для продления срока действия - метод prolong
ip
IPv4 скрытый за host:port
host
IPv4
port
Порт
user
Логин
pass
Пароль
type
Тип прокси: http - HTTPS, socks - SOCKS5
date
Дата покупки прокси
date_end
Дата окончания срока действия прокси
active
Активный (1) или нет (0)
category
Категория прокси
Метод "prolong"
Используется для продления текущих прокси
Параметры метода:
period
(Обязательный) - Период продления - кол-во дней
ids
(Обязательный) - Перечень внутренних номеров прокси в нашей системе, через запятую
coupon
Промокод (необязательно)
nokey
При добавлении данного параметра (nokey=1), список list будет возвращаться без ключей
https://proxy-store.com/api/{api_key}/prolong?period=30&ids=15,16
В примере выше мы продляем прокси с номерами 15 и 16 на 30 дней
В случае успешного ответа:
{
"status": "ok",
"period": 30,
"price": 12.6,
"count": 2,
"list": {
"15": {
"id": 15,
"date_end": "2016-07-12 11:50:41",
"unixtime_end": 1468349441
},
"16": {
"id": 16,
"date_end": "2016-07-16 09:31:21",
"unixtime_end": 1466379261
}
}
}
price
Итоговая стоимость продления
price_single
Стоимость одного прокси для указанного кол-ва и периода (отсутствует при продлении смешанного типа прокси)
period
Запрошенный период для продления (кол-во дней)
count
Кол-во успешных продлений
list
Массив продленных прокси
id
Внутренний номер прокси
date_end
Новая дата окончания срока действия прокси
Метод "autoprolong"
Используется для включения и выключения автопродления текущих прокси
*Автопродление доступно только на 30 дней
Параметры метода:
ids
(Обязательный) - Перечень внутренних номеров прокси в нашей системе, через запятую
coupon
Промокод (необязательно)
nokey
При добавлении данного параметра (nokey=1), список list будет возвращаться без ключей
enabled
1 - включить, 0 - выключить
https://proxy-store.com/api/{api_key}/autoprolong?ids=15,16&enabled=1
В примере выше мы включаем автопродление для прокси с номерами 15 и 16 на 30 дней.
В случае успешного ответа:
{
"code":200,
"data":{
"15":{
"status":"success",
"enabled":true
},
"16":{
"status":"success",
"enabled":true
}
}
}
code
Код ответа, 200 в случае успешного выполнения запроса
status
Статус включения/выключения автопродления для конкретного прокси
enabled/disabled
true если для прокси включилось/выключилось автопродление
Метод "delete"
Используется для удаления прокси
Параметры метода:
ids
(Обязательный) - Перечень внутренних номеров прокси в нашей системе, через запятую
https://proxy-store.com/api/{api_key}/delete?ids=15,16
В примере выше мы удаляем прокси с номерами 15 и 16
В случае успешного ответа:
{
"status": "ok",
"count": 2,
}
count
Кол-во удаленных прокси
Метод "check"
Используется для проверки валидности (работоспособности) прокси
Параметры метода:
ids
(Обязательный) - Внутренний номер прокси в нашей системе
https://proxy-store.com/api/{api_key}/check?ids=15
В примере выше мы проверяем прокси с номером 15.
В случае успешного ответа:
{
"status": "ok",
"proxies": [
{
"proxy_id": "15",
"proxy_status": true
}
]
}
proxy_id
Внутренний номер прокси
proxy_status
Результат проверки: true или false
Коды ошибок
Код
Текст
Описание
1
Error unknown
Неизвестная ошибка
2
Error key
Ошибка авторизации, неверный ключ
3
Error method
Ошибочный метод
4
Error count
Ошибка кол-ва прокси, неверно указано кол-во, либо отсутствует
5
Error period
Ошибка периода, неверно указан период (кол-во дней), либо отсутствует
6
Error country
Ошибка страны, неверно указана страна (страны указываются в формате iso2), либо отсутствует
7
Error category
Ошибка категории, неверно указана категория либо отсутствует
8
Error ids
Ошибка списка номеров прокси. Номера прокси должны быть указаны через запятую
9
Error coupon
Ошибка купона. Указан неверный просроченный купон
10
Error comment
Ошибка комментария, неверно указан, либо отсутствует
11
Error type
Ошибка типа (протокола) прокси, неверно указан, либо отсутствует
12
Error active proxy allow
Ошибка кол-ва прокси. Возникает при попытке покупки большего кол-ва прокси, чем доступно на сервисе
13
Error no money
Ошибка баланса. На вашем балансе отсутствуют средства, либо их не хватает для покупки запрашиваемого кол-ва прокси
404
Error not found
Ошибка поиска. Возникает когда запрашиваемый элемент не найден
14
Error price
Ошибка расчета стоимости. Итоговая стоимость меньше, либо равна нулю
