Звернення до 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,
"period": 30&,
"country": "us",
"count": 100
}
price
Підсумкова вартість
price_single
Вартість одного проксі
period
Запит на заявлений період (кількість днів)
count
Запит на кількість проксі
Метод "getcount"
Використовується для отримання інформації про доступну для покупки кількість проксі певної країни.
Параметри методу:
country
(Обов’язковий)- Код країни у форматі iso2
category
(Обов’язковий)- Категорія для покупки (з методу getcategory)
https://proxy-store.com/api/{api_key}/getcount?country=ru&category=for_all
У прикладі вище ми отримуємо інформацію про доступну для покупки кількість російських IPv4 проксі.
У разі успішної відповіді:
{
"status": "ok",
"count": 971,
}
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 - Усі (за замовчуванням)
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
},
"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
}
}
}
list_count
Кількість проксі
list
Масив проксі
id
Внутрішній номер проксі, необхідний для продовження терміну дії - метод prolong
ip
IPv4
port
Порт
user
Логін
pass
Пароль
type
Тип проксі: http - HTTPS, socks - SOCKS5
country
Країна (iso2)
date
Дата покупки проксі
date_end
Дата закінчення терміну дії проксі
comment
Коментар
Метод "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",
"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
}
}
}
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)
Метод "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
(Обов'язково) - Перелік внутрішніх номерів проксі в нашій системі, через кому
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
Помилка розрахунку вартості. Загальна вартість менша або дорівнює нулю
