Акаунт

Список всіх публично доступних методів для взаємодії з API.

GET

Ваш акаунт

Нове/account/view
Замінює старіші методи v2

Цей метод API v3 замінює такі методи API v2 (вони ще працюють):

Ваш обліковий запис

Профіль, валюта та — якщо токен має відповідні повноваження — залишок на рахунку.

Примітки

  • Потрібно user.read (область дії OAuth account:read); для отримання залишку на рахунку потрібно balance.read, яке входить до account:read.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -user.read
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/view

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/view", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
GET

Історія балансу

Нове/account/balance-history

Історія балансу

Усі поповнення, покупки, продовження та повернення коштів з балансу, упорядковані за датою (від найновіших до найстаріших), з нумерацією сторінок.

Примітки

  • Фільтруйте за типом, від, до (дати) або пошуком; суми вказані у валюті рахунку.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.history
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/balance-history

Параметри запиту

ІдентифікаторПравилаПриклад
typeНе обов'язковоnullableapp\_validators\_ex_in_rule""
with-hiddenНе обов'язковоnullableex-booleanfalse
fromНе обов'язковоnullabledatenull
toНе обов'язковоnullabledatenull
searchНе обов'язковоnullablestring131
redirect-urlНе обов'язковоnullableurl1003
per-pageНе обов'язковоnullableinteger83
pageНе обов'язковоnullableinteger44
sort-byНе обов'язковоnullablestringapp\_validators\_ex_in_rule""
sort-orderНе обов'язковоnullablestringin:asc, desc"asc"

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-history", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
GET

Збережені платіжні підписки

Нове/account/subscriptions

Збережені платіжні підписки

Картки та електронні гаманці, збережені для автоматичного поповнення, із зазначенням, чи увімкнено автоматичне поновлення.

Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.subscriptions
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/subscriptions

Параметри запиту

ІдентифікаторПравилаПриклад
fromНе обов'язковоnullabledatenull
toНе обов'язковоnullabledatenull
statusНе обов'язковоnullablenumeric0
searchНе обов'язковоnullablestring48
redirect-urlНе обов'язковоnullableurl75
per-pageНе обов'язковоnullableinteger38
pageНе обов'язковоnullableinteger90
sort-byНе обов'язковоnullablestringapp\_validators\_ex_in_rule""
sort-orderНе обов'язковоnullablestringin:asc, desc"asc"

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
PUT

Увімкнути або вимкнути автопродовження підписки

Нове/account/subscriptions/{subscription}/auto-renew

Увімкнути/вимкнути автоматичне поновлення

Увімкнення або вимкнення автоматичного поновлення однієї збереженої підписки. Кожен виклик функції змінює стан.

Примітки

  • Потрібний дозвіл account:manage.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.update
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

PUThttps://api.stableproxy.com/v3/account/subscriptions/{subscription}/auto-renew

Параметри запиту

ІдентифікаторПравилаПриклад
subscription1requiredinteger1

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions/{subscription}/auto-renew", {
3 method: "PUT",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
DELETE

Скасувати збережену підписку

Нове/account/subscriptions/{subscription}

Скасувати підписку

Припиняє дію та видаляє збережену підписку з оплатою. Суми, які вже були сплачені, не повертаються.

Примітки

  • Потрібний дозвіл account:manage. Перед викликом цієї функції слід запитати дозволу у користувача.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.un-subscribe
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

DELETEhttps://api.stableproxy.com/v3/account/subscriptions/{subscription}

Параметри запиту

ІдентифікаторПравилаПриклад
subscription1requiredinteger1

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/subscriptions/{subscription}", {
3 method: "DELETE",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
GET

Сповіщення про низький баланс

Нове/account/balance-alert
Замінює старіші методи v2

Цей метод API v3 замінює такі методи API v2 (вони ще працюють):

Повідомлення про низький залишок

Чи отримує користувач повідомлення, коли залишок на рахунку опускається нижче певного порогу, та який саме цей поріг у валюті рахунку.

Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.read
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/balance-alert

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-alert", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
PUT

Налаштувати сповіщення про низький баланс

Нове/account/balance-alert
Замінює старіші методи v2

Цей метод API v3 замінює такі методи API v2 (вони ще працюють):

Налаштування сповіщення про низький баланс

Увімкнення або вимкнення сповіщення та налаштування його порогового значення.

Примітки

  • enabled (логічне значення) та amount у валюті рахунку. Потрібні права account:manage.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -balance.update
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

PUThttps://api.stableproxy.com/v3/account/balance-alert

Параметри запиту

ІдентифікаторПравилаПриклад
enabledrequiredbooleanfalse
amountrequirednumeric91924

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/balance-alert", {
3 method: "PUT",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 },
8 body: JSON.stringify({
9 "enabled": "false",
10 "amount": 91924
11 })
12});
13const data = await response.json();
GET

Сповіщення

Нове/account/notifications
Замінює старіші методи v2

Цей метод API v3 замінює такі методи API v2 (вони ще працюють):

Повідомлення

Повідомлення користувача, розташовані в порядку від найновіших до найстаріших, з розбивкою на сторінки.

Примітки

  • mark-as-read=true також позначає їх як прочитані — але лише тоді, коли користувач їх переглянув.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -notifications.read
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/notifications

Параметри запиту

ІдентифікаторПравилаПриклад
mark-as-readНе обов'язковоnullableex-booleanfalse
searchНе обов'язковоnullablestring92
per-pageНе обов'язковоnullableinteger40
pageНе обов'язковоnullableinteger67
sort-byНе обов'язковоnullablestringapp\_validators\_ex_in_rule""
sort-orderНе обов'язковоnullablestringin:asc, desc"asc"

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/notifications", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();
GET

Способи поповнення

Нове/account/topup-methods

Способи поповнення

Способи оплати, доступні цьому користувачеві для поповнення балансу, із зазначенням відповідних лімітів.

Примітки

  • Поповнення за допомогою функцій Створити замовлення (action: topup) та Підтвердити та оплатити замовлення.
Для цього метода - потрібна авторизація!
Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.
Для цього методу - потрібні дозволи -topup.methods
При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/account/topup-methods

Приклади коду

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/account/topup-methods", {
3 method: "GET",
4 headers: {
5 "Authorization": "Bearer [YOUR TOKEN]",
6 "Content-Type": "application/json"
7 }
8});
9const data = await response.json();