API - Přehled

API - Soubory, písma a měny

Stahujte veřejné i chráněné soubory a načítejte seznam písem a dostupné měny.

Přehled koncových bodů

MetodaKoncový bodPopisPřístup
GET/public-api/v1/file/public/products/:productId/:sizeVrací veřejný náhled produktu. Size musí být small.png, medium.png nebo big.png.veřejný
GET/public-api/v1/file/protected/:keyVrací chráněný soubor podle klíče úložiště.podepsané URL nebo files:read
GET/public-api/v1/fontsVrací všechna dostupná písma.veřejný
GET/public-api/v1/currenciesVrací všechny měny.veřejný

Soubory, písma a měny

Veřejné soubory náhledů lze snadno používat v prohlížeči. Chráněné soubory vyžadují podepsané URL nebo přístupové údaje API s files:read. Písma a měny mají veřejné koncové body pro čtení.

Koncový bodPřístupPodrobnosti
/file/public/products/:productId/small.pngveřejnýMalý náhled produktu.
/file/public/products/:productId/medium.pngveřejnýStřední náhled produktu.
/file/public/products/:productId/big.pngveřejnýVelký náhled produktu.
/file/protected/:keypodepsané URL nebo files:readChráněný soubor v objektovém úložišti.
/fontsveřejnýPole záznamů písem.
/currenciesveřejnýPole záznamů měn.

Příklad požadavku (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());

Příklad odpovědi

[
  {
    "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
  }
]