API - Überblick

API - Dateien, Schriftarten und Währungen

Rufe öffentliche und geschützte Dateien, die Schriftartenliste und verfügbare Währungen ab.

Endpunktübersicht

MethodeEndpunktBeschreibungZugriff
GET/public-api/v1/file/public/products/:productId/:sizeGibt eine öffentliche Produktvorschau zurück. Die Größe muss small.png, medium.png oder big.png sein.öffentlich
GET/public-api/v1/file/protected/:keyGibt eine geschützte Datei anhand ihres Speicherschlüssels zurück.signierte URL oder files:read
GET/public-api/v1/fontsGibt alle verfügbaren Schriftarten zurück.öffentlich
GET/public-api/v1/currenciesGibt alle Währungen zurück.öffentlich

Dateien, Schriftarten und Währungen

Öffentliche Vorschaudateien sind für Browser geeignet. Geschützte Dateien erfordern eine signierte URL oder API-Zugangsdaten mit files:read. Schriftarten und Währungen sind öffentlich lesbare Endpunkte.

EndpunktZugriffDetails
/file/public/products/:productId/small.pngöffentlichKleine Produktvorschau.
/file/public/products/:productId/medium.pngöffentlichMittlere Produktvorschau.
/file/public/products/:productId/big.pngöffentlichGroße Produktvorschau.
/file/protected/:keysignierte URL oder files:readGeschützte Datei im Objektspeicher.
/fontsöffentlichArray von Schriftarteinträgen.
/currenciesöffentlichArray von Währungseinträgen.

Beispielanfrage (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());

Beispielantwort

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