API - Viewer, Configurator und Customizer

Rufe Produkte ab, verknüpfe sie mit Werkzeugen und erstelle sichere Einbettungssitzungen für Viewer, Configurator und Customizer.

Endpunktübersicht

Methode	Endpunkt	Beschreibung	Zugriff
`GET`	`/public-api/v1/products`	Gibt Shop-Produkte/-Designs mit Einbettungsverfügbarkeit und Medien-URLs zurück.	`products:read`
`GET`	`/public-api/v1/products/:id`	Gibt ein Shop-Produkt/-Design zurück.	`products:read`
`POST`	`/public-api/v1/embed/session`	Stellt ein kurzlebiges JWT für eingebettete Werkzeuge einschließlich des Modellgenerators aus.	`embed:session:create`
`GET`	`/public-api/v1/runtime/bootstrap`	Ermittelt den Laufzeitkontext aus einem Einbettungs-JWT.	`Bearer-Einbettungstoken`
`POST`	`/public-api/v1/runtime-bindings/sync-from-wordpress`	Erstellt oder aktualisiert Laufzeitzuordnungen aus WordPress-Produktzuordnungen.	`beliebige authentifizierte Zugangsdaten`
`PATCH`	`/public-api/v1/runtime-bindings/:id`	Aktualisiert eine Laufzeitzuordnung teilweise.	`beliebige authentifizierte Zugangsdaten`
`POST`	`/public-api/v1/runtime-bindings/:id/activate`	Aktiviert eine Laufzeitzuordnung.	`beliebige authentifizierte Zugangsdaten`
`POST`	`/public-api/v1/runtime-bindings/:id/deactivate`	Deaktiviert eine Laufzeitzuordnung.	`beliebige authentifizierte Zugangsdaten`

Shop-Produkte

Produktendpunkte geben Shop-Designs zurück, die als Viewer, Configurator oder Customizer eingebettet werden können.

Parameter	Erforderlich	Details
`name`	`nein`	Durchsucht Produkt-/Designnamen.
`customizer`	`nein`	true oder false.
`offset`	`nein`	Standard 0. Muss >= 0 sein.
`limit`	`nein`	Standard 9, maximal 50.
`order_by`	`nein`	id, name oder created_at.
`direction`	`nein`	ASC oder DESC.

Beispielanfrage (fetch)

const params = new URLSearchParams({
  limit: '20',
  offset: '0',
  name: 't-shirt',
  customizer: 'true',
  order_by: 'created_at',
  direction: 'DESC'
});

const products = await alterFetch(`/products?${params.toString()}`);
const product = await alterFetch('/products/381');

Beispielantwort

{
  "products": {
    "items": [
      {
        "id": 381,
        "name": "Men's T-Shirt",
        "createdAt": "2026-01-03T23:55:05.000Z",
        "productId": 4,
        "media": {
          "img": {
            "big": "https://alterproduct.com/public-api/v1/file/public/products/4/big.png",
            "medium": "https://alterproduct.com/public-api/v1/file/public/products/4/medium.png",
            "small": "https://alterproduct.com/public-api/v1/file/public/products/4/small.png"
          },
          "mockups": []
        },
        "storefrontProduct": {
          "id": 89,
          "idUserDesign": 381,
          "shareAccess": "public",
          "isCustomizer": 1
        },
        "runtimeBindings": [
          {
            "id": 42,
            "runtimeType": "customizer",
            "status": "active",
            "externalProductId": "wc_123"
          }
        ],
        "embeddable": {
          "viewer": true,
          "configurator": true,
          "customizer": true
        }
      }
    ],
    "total": 1
  }
}

Laufzeitzuordnungen verbinden externe Shop-Produkte mit Alter Product Designs und Laufzeittypen. Sie werden hauptsächlich von WordPress/WooCommerce-Integrationen und erweiterten Shop-Backends verwendet.

Parameter	Erforderlich	Details
`designId`	`nein`	ID eines Alter Product Designs, das dem Shop gehört.
`externalProductId`	`ja für die Synchronisierung`	Externe Produkt-ID, z. B. eine WooCommerce-Produkt-ID.
`runtimeType`	`ja für die Synchronisierung`	viewer, configurator oder customizer.
`status`	`nein`	draft, active, inactive, archived oder legacy_active.
`legacyStorefrontProductId`	`nein`	Optionale ID einer bisherigen Zuordnung.
`legacyBindingMeta`	`nein`	Optionale JSON-Metadaten, z. B. manifestHash.

Beispielanfrage (fetch)

await alterFetch('/runtime-bindings/sync-from-wordpress', {
  method: 'POST',
  body: JSON.stringify({
    bindings: [
      {
        externalProductId: 'wc_123',
        runtimeType: 'customizer',
        status: 'active',
        designId: 381,
        legacyBindingMeta: {
          manifestHash: 'a3b1...'
        }
      }
    ]
  })
});

await alterFetch('/runtime-bindings/42', {
  method: 'PATCH',
  body: JSON.stringify({
    status: 'inactive'
  })
});

await alterFetch('/runtime-bindings/42/activate', { method: 'POST' });
await alterFetch('/runtime-bindings/42/deactivate', { method: 'POST' });

wordpress_local

await alterFetch('/runtime-bindings/sync-from-wordpress', {
  method: 'POST',
  body: JSON.stringify({
    bindings: [
      {
        externalProductId: 'wc_123',
        runtimeType: 'viewer',
        status: 'active',
        externalDesign: {
          externalDesignKey: 'wp-design-381',
          productId: 4,
          title: 'WooCommerce local design',
          manifestUrl: 'https://yourstore.com/wp-content/uploads/alter/381/manifest.json',
          assetBaseUrl: 'https://yourstore.com/wp-content/uploads/alter/381/',
          manifestHash: 'a3b1...',
          sourceMeta: {
            pluginVersion: '1.2.0'
          }
        }
      }
    ]
  })
});

Beispielantwort

{
  "message": "runtimeBinding.syncCompleted",
  "runtimeBindings": [
    {
      "id": 42,
      "designId": 381,
      "externalProductId": "wc_123",
      "runtimeType": "customizer",
      "status": "active"
    }
  ]
}

Einbettungssitzungen und Laufzeitinitialisierung

Erstelle auf deinem Server ein kurzlebiges Einbettungstoken und übergib es an das iframe bzw. die Laufzeit. Diese ruft anschließend die Initialisierung mit einem Bearer-Token auf.

Parameter	Erforderlich	Details
`runtimeBindingId`	`empfohlen`	Bevorzugte Kennung für aktive Laufzeitzuordnungen.
`tool`	`ohne runtimeBindingId erforderlich`	designer \| viewer \| configurator \| customizer \| model-generator
`toolId`	`tool: model-generator`	Positive numerische ID des lokalen Generatorprojekts, nicht dessen UUID oder die WooCommerce-Produkt-ID.
`origin`	`ja`	Origin, auf dem die Einbettung dargestellt wird, z. B. https://yourstore.com.
`designId`	`eine Kennung`	Alter Product Design-ID. Nicht mit orderId kombinieren.
`orderId`	`eine Kennung`	Customizer-Bestell-ID. Nur für customizer gültig.
`cartKey + cartMode`	`nein`	Warenkorbkontext nur für Customizer. cartMode ist view oder edit.

Beispielanfrage (fetch)

const session = await alterFetch('/embed/session', {
  method: 'POST',
  headers: {
    'x-alter-client-fingerprint': '9f1b7a5e4b3c2d1f9f1b7a5e4b3c2d1f'
  },
  body: JSON.stringify({
    runtimeBindingId: 42,
    origin: 'https://yourstore.com'
  })
});

const bootstrapResponse = await fetch('https://alterproduct.com/public-api/v1/runtime/bootstrap', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${session.token}`
  }
});

const bootstrap = await bootstrapResponse.json();
console.log({ session, bootstrap });

Hinweise

await alterFetch('/embed/session', {
  method: 'POST',
  body: JSON.stringify({
    tool: 'customizer',
    origin: 'https://yourstore.com',
    orderId: 123
  })
});

await alterFetch('/embed/session', {
  method: 'POST',
  body: JSON.stringify({
    tool: 'viewer',
    origin: 'https://yourstore.com',
    designId: 381
  })
});

Beispielantwort

{
  "token": "eyJhbGciOiJIUzI1NiIsImtpZCI6IjEifQ...",
  "expiresIn": 900,
  "kid": "1",
  "mode": "design",
  "runtimeBindingId": 42,
  "runtimeType": "customizer"
}

Runtime bootstrap

{
  "runtimeBindingId": 42,
  "designId": 381,
  "productId": "wc_123",
  "runtimeType": "customizer",
  "storageMode": "wordpress_local",
  "manifestUrl": "https://yourstore.com/wp-content/uploads/alter/381/manifest.json",
  "assetBaseUrl": "https://yourstore.com/wp-content/uploads/alter/381/",
  "manifestHash": "a3b1...",
  "planCapabilities": {
    "viewer": true,
    "configurator": true,
    "customizer": true
  },
  "cartKey": null,
  "cartMode": null,
  "orderId": null
}