FonProxy logoFonProxy
УвійтиРеєстрація

API Рефералів

Реферальні точки FonProxy: отримання інформації про реферали, оновлення кодів, перегляд графіка рефералів та заробітків.

Updated 2026-04-09 16:13:00
API Рефералів

Для аутентифікації та заголовків, дивіться API Загальне.

Огляд

Отримати інформацію про реферал Auth required

GET /referral

Повертає реферальний код користувача, відсотки та статистику. Автоматично створює реферальний код при першому зверненні.

Відповідь

{
  "id": "xK9mR2pL1w",
  "code": "a3f8c2d1",
  "incomePercentage": 5,
  "salePercentage": 0,
  "clicks": 142,
  "registrations": 23,
  "totalIncome": 12.50,
  "pendingIncome": 3.75
}
Ім'яТипОпис
idstringID рефералу
codestringРедагований реферальний код (використовується в реферальному посиланні)
incomePercentagenumberВідсоток, який заробляє реферер за кожне поповнення користувача
salePercentagenumberВідсоток знижки для реферованих користувачів (в майбутньому)
clicksnumberЗагальна кількість відвідувачів, які прийшли через цей реферал
registrationsnumberЗагальна кількість користувачів, які зареєструвалися через цей реферал
totalIncomenumberЗагальний заробіток від рефералів (USD)
pendingIncomenumberНарахований заробіток від рефералів, який ще не зараховано (USD)

Код

Оновлення реферального коду Auth required

PATCH /referral/code

Оновлює реферальний код. Повинен бути від 3 до 30 символів, алфавітно-цифровий + підкреслення + дефіс.

Тіло запиту

Ім'яТипОписОбов'язкове
codestringНовий реферальний кодТак

Відповідь

{ "code": "john_doe", "message": "referral.code_updated" }

Помилки:

{ "message": "referral.code_invalid" }
{ "message": "referral.code_taken" }

Аналітика

Графік рефералів Auth required

GET /referral/graph

Повертає часові дані для графіка кліків, реєстрацій та доходу.

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

Ім'яТипОписОбов'язкове
fromstringПочаток ISO дати. За замовчуванням 30 днів томуНі
tostringКінець ISO дати. За замовчуванням заразНі
granularitystringhour, day, week, month. За замовчуванням автоматичноНі

Відповідь

{
  "graph": "referral",
  "granularity": "day",
  "from": "2026-02-23T00:00:00.000Z",
  "to": "2026-03-25T00:00:00.000Z",
  "series": [
    {
      "key": "clicks",
      "label": "Clicks",
      "color": "#3B82F6",
      "points": [
        { "t": "2026-03-24T00:00:00.000Z", "v": 15 },
        ...
      ]
    },
    {
      "key": "registrations",
      "label": "Registrations",
      "color": "#22C55E",
      "points": [
        { "t": "2026-03-24T00:00:00.000Z", "v": 3 },
        ...
      ]
    },
    {
      "key": "income",
      "label": "Income (USD)",
      "color": "#E6318B",
      "points": [
        { "t": "2026-03-24T00:00:00.000Z", "v": 2.50 },
        ...
      ]
    }
  ],
  "meta": { "currency": "USD" }
}

Як працюють реферали

  1. Користувач отримує унікальний реферальний код через GET /referral
  2. Інтерфейс створює посилання: https://fonproxy.com/?ref=<code>
  3. Відвідувач приходить → заноситься в базу даних.
  4. Відвідувач реєструється → invitedById встановлюється для нового користувача + реферера повідомляють
  5. Реферований користувач поповнює рахунок → створюється нарахування транзакції реферального доходу для реферера
  6. Через 2 дні (в dev режимі миттєво) нарахування списується на баланс реферера + реферера повідомляють
  7. Користувач може відстежувати все в GET /referral та GET /referral/graph