API - Overblik

API - Filer, skrifttyper og valutaer

Hent offentlige og beskyttede filer, listen over skrifttyper og de tilgængelige valutaer.

Endpointoversigt

MetodeEndpointBeskrivelseAdgang
GET/public-api/v1/file/public/products/:productId/:sizeReturnerer en offentlig produktforhåndsvisning. Størrelsen skal være small.png, medium.png eller big.png.offentlig
GET/public-api/v1/file/protected/:keyReturnerer en beskyttet fil efter lagernøgle.signeret URL eller files:read
GET/public-api/v1/fontsReturnerer alle tilgængelige skrifttyper.offentlig
GET/public-api/v1/currenciesReturnerer alle valutaer.offentlig

Filer, skrifttyper og valutaer

Offentlige forhåndsvisningsfiler kan bruges i browsere. Beskyttede filer kræver en signeret URL eller API-legitimationsoplysninger med files:read. Skrifttyper og valutaer har offentlige læseendpoints.

EndpointAdgangDetaljer
/file/public/products/:productId/small.pngoffentligLille produktforhåndsvisning.
/file/public/products/:productId/medium.pngoffentligMellemstor produktforhåndsvisning.
/file/public/products/:productId/big.pngoffentligStor produktforhåndsvisning.
/file/protected/:keysigneret URL eller files:readBeskyttet fil i objektlager.
/fontsoffentligArray med skrifttypeposter.
/currenciesoffentligArray med valutaposter.

Eksempel på anmodning (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());

Eksempel på svar

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