API - Огляд

API - Файли, шрифти й валюти

Завантажуйте загальнодоступні й захищені файли, отримуйте список шрифтів і доступних валют.

Огляд кінцевих точок

МетодКінцева точкаОписДоступ
GET/public-api/v1/file/public/products/:productId/:sizeПовертає публічний перегляд товару. Розмір має бути small.png, medium.png або big.png.публічний
GET/public-api/v1/file/protected/:keyПовертає захищений файл за ключем сховища.підписана URL-адреса або files:read
GET/public-api/v1/fontsПовертає всі доступні шрифти.публічний
GET/public-api/v1/currenciesПовертає всі валюти.публічний

Файли, шрифти й валюти

Публічні файли перегляду зручні для браузера. Захищені файли потребують підписаної URL-адреси або облікових даних API з files:read. Шрифти й валюти доступні через публічні кінцеві точки читання.

Кінцева точкаДоступПодробиці
/file/public/products/:productId/small.pngпублічнийМалий перегляд товару.
/file/public/products/:productId/medium.pngпублічнийСередній перегляд товару.
/file/public/products/:productId/big.pngпублічнийВеликий перегляд товару.
/file/protected/:keyпідписана URL-адреса або files:readЗахищений файл об’єктного сховища.
/fontsпублічнийМасив записів шрифтів.
/currenciesпублічнийМасив записів валют.

Приклад запиту (fetch)

const publicPreview = await fetch(
  'https://alterproduct.com/public-api/v1/file/public/products/4/medium.png'
);

const protectedFile = await fetch(
  'https://alterproduct.com/public-api/v1/file/protected/user_34/381/design/mockup-large.webp',
  {
    headers: authHeaders
  }
);

const fonts = await fetch('https://alterproduct.com/public-api/v1/fonts').then((res) => res.json());
const currencies = await fetch('https://alterproduct.com/public-api/v1/currencies').then((res) => res.json());

Приклад відповіді

[
  {
    "id": 1,
    "family": "Inter",
    "source": "google",
    "category": "sans-serif",
    "variants": ["regular", "600", "700"],
    "subsets": ["latin"],
    "version": "v19",
    "menu": "Inter",
    "files": {
      "regular": "https://..."
    }
  }
]
[
  {
    "id": 1,
    "code": "EUR",
    "name": "Euro",
    "symbol": "€",
    "decimalPlaces": 2
  }
]