API - Ressourcen und Importe

Durchsuche den Ressourcenkatalog, rufe Manifeste und Dateien ab und importiere Projekte.

Endpunktübersicht

Methode	Endpunkt	Beschreibung	Zugriff
`GET`	`/public-api/v1/assets`	Listet Asset-Katalogeinträge des angeforderten Typs auf.	`beliebige authentifizierte Zugangsdaten`
`GET`	`/public-api/v1/assets/:type/:assetId`	Gibt ein Asset-Manifest mit herunterladbaren Dateirollen zurück.	`beliebige authentifizierte Zugangsdaten`
`GET`	`/public-api/v1/assets/:type/:assetId/files/:role`	Lädt eine Asset-Datei anhand ihrer Rolle herunter.	`beliebige authentifizierte Zugangsdaten`
`GET`	`/public-api/v1/design-imports`	Listet importierbare, bei Alter gehostete Designs auf.	`authentifizierte Zugangsdaten, Business-Tarif erforderlich`
`GET`	`/public-api/v1/design-imports/:id`	Gibt Designimportdaten und Dateibeschreibungen zurück.	`authentifizierte Zugangsdaten, Business-Tarif erforderlich`
`GET`	`/public-api/v1/design-imports/:id/files/:fileId`	Lädt eine Datei aus einer Designimportbeschreibung herunter.	`authentifizierte Zugangsdaten, Business-Tarif erforderlich`

Asset-Katalog

Der Asset-Katalog stellt Produktquellassets, Hintergründe, Umgebungen, Grafiken, Designvorlagen und Mockup-Assets bereit. Listenendpunkte liefern schlanke Beschreibungen; Detailendpunkte enthalten Dateimanifeste.

Typ	Beschreibung
`products`	Basis-Produktassets, Vorschauen, 3D-Modelle sowie Material- und Texturbeschreibungen.
`backgrounds`	Statische Viewer-Hintergründe.
`environments`	Umgebungskarten und Vorschaubilder.
`image_library`	Assets der Grafikbibliothek, einschließlich shopspezifischer Grafiken.
`design_templates`	Vorschauen von Designvorlagen und Verweise auf Ebenendateien. Unterstützt den Filter product_id.
`mockups`	Assets, Hintergründe und Überlagerungskarten des Mockup-Generators. Unterstützt den Filter product_id.

Beispielanfrage (fetch)

const assets = await alterFetch('/assets?' + new URLSearchParams({
  type: 'products',
  limit: '20',
  offset: '0',
  search: 'mug'
}));

const details = await alterFetch('/assets/products/4');

const fileResponse = await fetch(
  'https://alterproduct.com/public-api/v1/assets/products/4/files/preview_medium',
  {
    headers: authHeaders
  }
);

const fileBlob = await fileResponse.blob();

Beispielantwort

{
  "type": "products",
  "items": [
    {
      "assetType": "products",
      "assetId": "4",
      "title": "Mug 450ml",
      "slug": "product-4",
      "description": "Base product 4",
      "primaryRole": "preview_big",
      "fileCount": 8,
      "remoteVersion": "1.0",
      "thumbnail": {
        "role": "preview_small",
        "fileName": "product-4-preview-small.png",
        "mime": "image/png",
        "downloadPath": "/v1/assets/products/4/files/preview_small"
      },
      "metadata": {
        "productCategoryId": 2,
        "productModelCount": 1,
        "isDedicated": false
      }
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

Designimporte

Designimporte stellen bei Alter gehostete Designs und ihre Dateien für externe Produktions- oder Migrationsabläufe bereit. Die API prüft die Berechtigung des Business-Tarifs.

Parameter	Erforderlich	Details
`search`	`nein`	Durchsucht Designtitel oder ID.
`offset`	`nein`	Standard 0.
`limit`	`nein`	Standard 20, maximal 100.

Beispielanfrage (fetch)

const imports = await alterFetch('/design-imports?' + new URLSearchParams({
  limit: '20',
  offset: '0',
  search: 'mug'
}));

const details = await alterFetch('/design-imports/381');

const fileId = details.files[0].id;
const fileResponse = await fetch(
  `https://alterproduct.com/public-api/v1/design-imports/381/files/${fileId}`,
  {
    headers: authHeaders
  }
);

const fileBlob = await fileResponse.blob();

Beispielantwort

{
  "eligible": true,
  "requiredPlan": "Business",
  "currentPlanName": "Business",
  "designs": [
    {
      "id": 381,
      "title": "Men's T-Shirt",
      "createdAt": "2026-01-03T23:55:05.000Z",
      "sourceStorefrontId": 12,
      "productId": 4,
      "productName": {
        "pl": "Koszulka",
        "en": "T-Shirt"
      },
      "storageMode": "alter",
      "runtimeStatus": {
        "designer": true,
        "viewer": true,
        "configurator": true,
        "customizer": true
      },
      "thumbnail": {
        "kind": "design-mockup",
        "fileId": "7df7...",
        "downloadPath": "/v1/design-imports/381/files/7df7..."
      }
    }
  ],
  "total": 1
}