Документація API
Список всіх публично доступних методів для взаємодії з API.
- Головна
- ### Calculate order Calculate given order and return the result, this is used in plan selector to show the price of the order. (1 методів)
- ### Pre-Purchase order Convert your order to buy request, then send __order_id__,__total_price__ to [v2/cart/purchaser](/apidocs/cart/purchase). (1 методів)
- Get proxies in given package. (1 методів)
- Get all user info, for example: name, email, currency, balance, phone, social links, features. (1 методів)
- Checker (4 методів)
- Conversation (6 методів)
- Get available city in residential country or regions (1 методів)
- Get available regions in residential country (1 методів)
- Get proxy bfrom list by index. (1 методів)
- Retrieve user actual balance. (1 методів)
- Отримати список активних пакетів (1 методів)
- Retrieve user balance history. (1 методів)
- ### OAuth start request This request is giving url for oauth authorization, then it will redirect to redirect url with oauth-uid and oauth-signature #### Target Auth URL This is url where user complete oauth authorization (our endpoint). #### Where get API Application? You need contact us in [support](/support) and we will give you API Application (1 методів)
- Return information oauth provider and API application (1 методів)
- Return list of allowed targets (which can be used in oauth). (1 методів)
- Get active user sessions. (1 методів)
- Obtain a list of the user's API tokens. (1 методів)
- Створіть новий токен API для користувача. (1 методів)
- Get info about specified user's API token. (1 методів)
- Delete specified user's API token. (1 методів)
- Отримати баланс користувача передплати (1 методів)
- Referral (9 методів)
- Список реферальних токенів Реферальні(10 методів)
- Створити реферальний токен Реферальний(10 методів)
- Видалити реферальний токен Реферальний(10 методів)
- Оновити реферальний токен Реферальний(10 методів)
- Переглянути реферальний токен Реферальний(10 методів)
- Список зареєстрованих користувачів Реферали(10 методів)
- Список отриманих транзакцій Реферальна програма(10 методів)
- Список відвідувань за токеном Реферал(10 методів)
- Зведена статистика Рекомендація(10 методів)
- Get user who referred current user. (1 методів)
- Отримати сесію за ідентифікатором. (1 методів)
- Get order / prices information by package. (1 методів)
- Get balance history entry. (1 методів)
- Unsubscribe from balance subscription. (1 методів)
- Увімкнути поновлення передплати (тільки для збережених) (1 методів)
- Скасувати неактивний пакет (без проксі-серверів), також повернути гроші) (1 методів)
- Delete (1 методів)
- Retrieve download hash for package, for download package proxies. (1 методів)
- Reset download hash for package, old hash will not be valid anymore. (1 методів)
- Download proxies in specific format, with specific connection type (1 методів)
- Отримати функції пакета (1 методів)
- Пакет (1 методів)
- Hide selected proxy from list (but it will work, only visual)) (1 методів)
- You can read note for proxy. (1 методів)
- Add personal note for proxy in package. (1 методів)
- ### Як змінити? Тут ви можете керувати своїм замовленням, наприклад, змінювати кількість, трафік, період, країни тощо. Для зміни замовлення вам потрібні __гроші__. (1 методів)
- ### How to? Replace ips in package, if you want to add new ips, you need to add them to the `add_countries` array, if you want to remove ips, you need to add them to the `remove_ids` array. You need __money__ to replace ips, if you have __free replacements__ you can use them. (1 методів)
- Це поновлення пакету на наступний період. Для поновлення пакету вам потрібно __гроші__. (1 методів)
- Change or add traffic to order. You need __money__ to change traffic. (1 методів)
- Rotate proxy, residential, mobile - change ip. (1 методів)
- Add custom user proxy, like for residential constructor. (1 методів)
- Видалити проксі користувача (створений тільки користувачем). (1 методів)
- Replace proxies by given sequence. (1 методів)
- Return package settings, like name, description, etc. (1 методів)
- Change selected settings for given package. (1 методів)
- Get available connection servers (Some servers can give better speed). (1 методів)
- Change the connection bridge to other. (1 методів)
- Same as list but fetch only one. (1 методів)
- Logout from session, if id is not provided, logout from current session. (1 методів)
- Get and read all user notifications. (1 методів)
- Phone status (1 методів)
- Отримати всі налаштування користувача, наприклад: ім'я, електронна адреса, валюта. (1 методів)
- Update user settings, for example: name, email, currency. Some settings need confirmation, for example: email. (1 методів)
- Available countries (1 методів)
- Cart (1 методів)
- Get all config for calculator, like: rules for counts, traffic, paid period, etc. This is used in plan selector to show the rules for the order. (1 методів)
- ### Purchase order This method is used to purchase the order, you need to send the _order_id_, _overall_ *(Is total_price, based on user currency)* from [v2/cart/order](/apidocs/cart/order) to this endpoint to purchase the order. (1 методів)
- ### Sale percentage #### What is the sale percentage? Sale percentage is a discount that is applied to the price of the order. The sale percentage is calculated based on the user's activity on the site, or referrals. The more active the user is, the higher the discount. #### Referral program It uses __sp-referral__ header as a referral code, more you can find on [wiki welcome page](/apidocs). #### How to apply the sale percentage? This is already calculated in the price of the orders, you don't need to do anything, just purchase the order. (1 методів)
- Отримати курси валют (1 методів)
- Get current activated abilities for api token. (1 методів)
- Перевірте, чи має токен можливість щось робити. (1 методів)
- Make payment request, then redirect to payment page. (1 методів)
- Отримайте дозвіл та активуйте способи оплати (у деяких країнах можуть бути обмеження). (1 методів)
- Calculates your amount after applying active promocodes / bonuses. (1 методів)
- Статистика (1 методів)
- Phone (1 методів)
- Аватар (1 методів)
- Other linked accounts (3 методів)
- Отримайте доступні для активації промокоди. (1 методів)
- Get active promocodes for user. (1 методів)
- Отримати функції користувача (1 методів)
- Перемикання функцій (1 методів)
- Bonuses (1 методів)
Які методи підтримується?
Для публічного API доступно 90% функціоналу сайту; інша частина недоступна, оскільки може бути прив’язана до фронтенду або заблокована з міркувань безпеки.
Автопереклад!
Зверніть увагу! Усі переклади виконано автоматично. Розробникам рекомендується ознайомитися з англійською версією.
HTTP Заголовки
X-CSRF-Token
Токен CSRF, потрібен тільки якщо використовувати як фронтенд.
Locale
Мова для відповідей, наразі є підтримка: en, ru, uk, pl
Authorization
Авторизація, перед токеном треба вказувати: API-Token
SP-Referral
Реферальний код, необхідний для знижки (якщо користувача не створено).
sp-site
Сайт, з якого використовується токен (використовується для внутрішньої аналітики; можете вказати назву вашого проєкту).
sp-comefrom
Мітка звідки прийшов користувач (наприклад Google Search)
Відповідь
1{
2 "data": { // Дані які повернув метод
3 "user": ....
4 },
5 "good": true, // Успішність запиту (іноді при 200 може повертати false)
6 "timestamp": 1731493828, // Час старту запиту (коли сервер почав обробляти дані)
7 "cause": { // Ким був виконан цей метод + підпис токену (можна перевірити користувача
8 "type": "api",
9 "user_id": 1,
10 "token_id": 75,
11 "token_sign": "63992323944b77852d3b2b901498fc57"
12 }
13}
14 
