API - Oversikt

API - Filer, skrifttyper og valutaer

Hent offentlige og beskyttede filer, listen over skrifttyper og tilgjengelige valutaer.

Endepunktoversikt

MetodeEndepunktBeskrivelseTilgang
GET/public-api/v1/file/public/products/:productId/:sizeReturnerer en offentlig produktforhåndsvisning. Størrelsen må være small.png, medium.png eller big.png.offentlig
GET/public-api/v1/file/protected/:keyReturnerer en beskyttet fil etter lagringsnøkkel.signert URL eller files:read
GET/public-api/v1/fontsReturnerer alle tilgjengelige skrifter.offentlig
GET/public-api/v1/currenciesReturnerer alle valutaer.offentlig

Filer, skrifter og valutaer

Offentlige forhåndsvisningsfiler kan brukes i nettleseren. Beskyttede filer krever en signert URL eller API-legitimasjon med files:read. Skrifter og valutaer er offentlige leseendepunkter.

EndepunktTilgangDetaljer
/file/public/products/:productId/small.pngoffentligLiten produktforhåndsvisning.
/file/public/products/:productId/medium.pngoffentligMellomstor produktforhåndsvisning.
/file/public/products/:productId/big.pngoffentligStor produktforhåndsvisning.
/file/protected/:keysignert URL eller files:readBeskyttet fil i objektlagring.
/fontsoffentligListe med skriftposter.
/currenciesoffentligListe med valutaposter.

Eksempelforespørsel (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());

Eksempelsvar

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