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();