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
  }
]