API General

Базовий URL: https://api.fonproxy.io

Аутентифікація

Усі захищені кінцеві точки вимагають API ключ:

Згенеруйте API ключ у вашому обліковому записі: API Keys.

Локаль

API використовує заголовок fp-locale для визначення мови користувача.

fp-locale: uk

Поведінка

• Кожен запит: бекенд читає fp-locale і використовує його для контенту, згенерованого на сервері (електронні листи, сповіщення Telegram).
• Авторизовані користувачі: якщо значення заголовка відрізняється від збереженої локалі, бекенд автоматично оновлює локаль користувача в базі даних (асинхронно, без додаткового запиту).
• Підтримувані локалі: en (англійська, за замовчуванням), uk (українська).
• Отримати поточний список локалей під час виконання: GET /locales
• Резерв: якщо заголовок відсутній або локаль невідома, використовується en.

Що Перекладається

Поле locale завжди повертається в профілі користувача (GET /user/me), щоб фронтенд міг відповідно ініціалізувати свою локалізацію.

Загальні Заголовки

Формат Відповіді

Усі відповіді є в форматі JSON. Успішні відповіді повертають дані безпосередньо:

{
  "user": { "id": "k5Xz9qR2Wp", "name": "John", ... }
}

Відповіді на помилки:

{
  "message": "order.not_found",
  "path": "/orders/80-12345",
  "timestamp": "2026-04-01T12:00:00.000Z"
}

Поле message є ключем перекладу — фронтенд перекладає його у читабельний рядок.

Пагінація

Кінцеві точки з пагінацією приймають:

Відповідь містить:

{
  "items": [ ... ],
  "total": 142,
  "page": 1,
  "pages": 8
}

Валюта

• Усі ціни та залишки зберігаються у USD внутрішньо.
• Значення для відображення конвертуються за допомогою актуальних валютних курсів.
• Валюта відображення, що надає перевагу користувач, задається через PATCH /user/settings { "currency": "UAH" }.
• Кінцеві точки, які повертають грошові значення, включають поля *Usd і *Display.

Обмеження Швидкості

Обмеження на IP-адресу. За замовчуванням: 60 запитів/хвилина для більшості кінцевих точок, 5/хвилина для кінцевих точок автентифікації.

Коли досягається ліміт швидкості, API повертає 429 Too Many Requests:

{ "message": "error.rate_limit" }

Локалі

GET /locales

Повертає всі поточно підтримувані коди локалей з їх відображуваними назвами.

Відповідь:

{
  "locales": [
    { "code": "en", "name": "English", "nativeName": "English" },
    { "code": "uk", "name": "Ukrainian", "nativeName": "Українська" }
  ]
}

Валюта

GET /currencies

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

Відповідь:

{
  "currencies": ["USD", "EUR", "GBP", "PLN", "CZK", "HUF", "RON", "SEK", "NOK", "DKK", "CHF", "HRK", "BGN", "UAH", "TRY"]
}

GET /currencies/rates

Повертає останні валютні курси за кодами валют. Кожне значення — "1 базова = N цільова" — з base=USD, "EUR": 0.92 означає, що 1 USD купує 0.92 EUR. Публічний, автентифікація не потрібна.

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

Відповідь:

{
  "base": "USD",
  "rates": {
    "USD": 1,
    "EUR": 0.92,
    "UAH": 41.2,
    ...
  }
}

Помилки:

API Довідник

Публічний

Адмін