API Документація — Реферальна програма

GET

Підсумок реферальної програми

Нове/referral/summary

Замінює старіші методи v2

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

Реферальна програма

Звіт про реферальну програму

Підсумкові показники реферальної програми: відвідування, реєстрації, заробіток та сума, готова до виведення.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.read

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/referral/summary

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

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

GET

Реферальні посилання

Нове/referral/links

Реферальні посилання

Реферальні посилання користувача з їхніми кодами та лічильниками.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.read

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/referral/links

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

Ідентифікатор	Правила	Приклад
searchНе обов'язково	nullablestring	26
per-pageНе обов'язково	nullableinteger	23
pageНе обов'язково	nullableinteger	73
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 + "/referral/links", {
3  method: "GET",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  }
8});
9const data = await response.json();

POST

Створити реферальне посилання

Нове/referral/links

Створити реферальне посилання

Додає реферальне посилання. Параметр name визначає його назву; параметр token (4–12 символів) дозволяє вибрати код, інакше код генерується автоматично.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.create

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

POSThttps://api.stableproxy.com/v3/referral/links

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

Ідентифікатор	Правила	Приклад
nameНе обов'язково	nullablestring	24
tokenНе обов'язково	nullablestring	8

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

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/referral/links", {
3  method: "POST",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  },
8  body: JSON.stringify({
9    "name": 24,
10    "token": 8
11  })
12});
13const data = await response.json();

PUT

Змінити реферальне посилання

Нове/referral/links/{id}

Змінити реферальне посилання

Змінює назву або код реферального посилання.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.update

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

PUThttps://api.stableproxy.com/v3/referral/links/{id}

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

Ідентифікатор	Правила	Приклад
nameНе обов'язково	nullablestring	45
tokenНе обов'язково	nullablestring	4
id	1requiredinteger	1

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

1const baseUrl = "https://api.stableproxy.com/v3";
2const response = await fetch(baseUrl + "/referral/links/{id}", {
3  method: "PUT",
4  headers: {
5    "Authorization": "Bearer [YOUR TOKEN]",
6    "Content-Type": "application/json"
7  },
8  body: JSON.stringify({
9    "name": 45,
10    "token": 4
11  })
12});
13const data = await response.json();

DELETE

Видалити реферальне посилання

Нове/referral/links/{id}

Видалити реферальне посилання

Видаляє реферальне посилання; користувачі, які вже зареєструвалися за ним, залишаються рефералами.

Примітки

Перед викликом цієї функції слід запитати дозволу у користувача.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.delete

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

DELETEhttps://api.stableproxy.com/v3/referral/links/{id}

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

Ідентифікатор	Правила	Приклад
id	1requiredinteger	1

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

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

GET

Хто зареєструвався за посиланням

Нове/referral/links/{id}/referrals

Користувачі, які зареєструвалися за реферальним посиланням

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

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.read

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/referral/links/{id}/referrals

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

Ідентифікатор	Правила	Приклад
per-pageНе обов'язково	nullableinteger	2
pageНе обов'язково	nullableinteger	70
sort-byНе обов'язково	nullablestringapp\_validators\_ex_in_rule	""
sort-orderНе обов'язково	nullablestringin:asc, desc	"asc"
id	1requiredinteger	1

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

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

GET

Нарахування за реферальним посиланням

Нове/referral/links/{id}/earnings

Заробіток за рефералів

Винагороди, отримані за одним реферальним посиланням, з розбивкою по сторінках.

Для цього метода - потрібна авторизація!

Ви можете використовувати власний API ключ, котрий можна отримати в панелі керування.

Для цього методу - потрібні дозволи -referral.read

При створенні API токена у вашій панелі керування ви можете обрати певні дозволи (наприклад: заборонити токену робити замовлення).
Також список дозволів можна отримати у нашій документації.

Метод запита

GEThttps://api.stableproxy.com/v3/referral/links/{id}/earnings

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

Ідентифікатор	Правила	Приклад
per-pageНе обов'язково	nullableinteger	39
pageНе обов'язково	nullableinteger	46
sort-byНе обов'язково	nullablestringapp\_validators\_ex_in_rule	""
sort-orderНе обов'язково	nullablestringin:asc, desc	"asc"
id	1requiredinteger	1

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

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