API - Generátor 3D modelů

Generátor 3D modelů

Endpointy pro import generátoru slouží pouze ke čtení při komunikaci mezi servery. Vyžadují standardní hlavičky API, oprávnění embed:session:create a aktivní plán. Autorizace importu nevytváří relaci editoru a nečerpá její měsíční limit. Otevření editoru používá stejný čítač monthlyEmbedTokenLimit jako ostatní vložené nástroje.

Vyhledávání a import modelů s generátorem

Pomocí /model-generator/models zobrazíte dostupné modely s generátory. Deskriptor generator určuje konkrétní projectId, revision, configurationId, templateRevision, productId a productModel3dId. Prostřednictvím jeho importPath načtěte přesně tuto zdrojovou revizi. Manifesty produktových podkladů zpřístupňují také generators a deskriptor generator jednotlivých modelů. Šablony lze importovat samostatně podle konfigurace a revize.

Filtry katalogů

Import projektu obsahuje document, revision, template a manifest files. Každý soubor uvádí path v prostoru /v1/model-generator/; při stahování z Alter Product před něj přidejte /public-api. Zkopírujte požadované soubory do vlastního úložiště a nahraďte zdrojové odkazy místními. Figuríny a knihovny textur importujte přes jejich katalogové endpointy; public-files povoluje pouze schválené cesty ke zdrojům a šablony podléhají kontrole přístupu ke konfiguraci a revizi.

Příklad požadavku (fetch)

// Server-side: uses alterFetch and authHeaders from the API connection guide.
const catalog = await alterFetch('/model-generator/models?' + new URLSearchParams({
  scope: 'all', limit: '24', offset: '0'
}));

const selected = catalog.items[0];
if (!selected?.generator) throw new Error('Select an available generator model');

const importPath = selected.generator.importPath;
if (!importPath.startsWith('/v1/model-generator/projects/')) {
  throw new Error('Invalid generator import path');
}
const bundle = await alterFetch(importPath.slice('/v1'.length));

for (const file of bundle.files) {
  if (!file.path.startsWith('/v1/model-generator/')) {
    throw new Error('Invalid generator file path');
  }
  const response = await fetch('https://alterproduct.com/public-api' + file.path, {
    headers: authHeaders,
    redirect: 'error'
  });
  if (!response.ok) throw new Error(`File download failed: ${response.status}`);
  const bytes = new Uint8Array(await response.arrayBuffer());
  // Persist bytes in your local storage; record the mapping from
  // file.sourceHref / file.href to the resulting local file reference.
}
// Persist bundle.document, bundle.template and revision metadata locally.
// Import the related product asset and its textures/mockups as needed:
const product = await alterFetch('/assets/products/' + selected.generator.productId);
const mannequins = await alterFetch('/model-generator/mannequins');
console.log({ product, mannequins });

Relace editoru a místní ukládání

Vytvořte relaci editoru s tool: model-generator, kladným číselným toolId místního projektu generátoru (nikoli jeho UUID ani ID produktu WooCommerce) a povoleným origin obchodu. Pro tento nástroj nepředávejte designId, orderId, runtimeBindingId ani pole košíku. UUID projektu generátoru je samostatný identifikátor. Předejte získaný token prostřednictvím handshake iframe; runtime bootstrap vrátí kontext generátoru se storageMode: wordpress_local.

// Server-side, after authorizing the merchant's access to this local project.
const localProjectId = 42; // Local generator project ID, not its UUID or WC product ID.
const session = await alterFetch('/embed/session', {
  method: 'POST',
  body: JSON.stringify({
    tool: 'model-generator',
    toolId: localProjectId,
    origin: 'https://yourstore.com'
  })
});

// The iframe receives session.token through ALTER_CUSTOMIZER_SESSION_READY.
// Do not put API credentials or the token in the iframe URL.
const bootstrapResponse = await fetch('https://alterproduct.com/public-api/v1/runtime/bootstrap', {
  headers: { Authorization: `Bearer ${session.token}` }
});
if (!bootstrapResponse.ok) throw new Error('Generator bootstrap failed');
const context = await bootstrapResponse.json();
console.log(context);

Příklad odpovědi

{
  "runtimeBindingId": null,
  "designId": null,
  "productId": 42,
  "toolId": 42,
  "runtimeType": "model-generator",
  "storageMode": "wordpress_local",
  "parentOrigin": "https://yourstore.com"
}

// Host page: WordPress returns a numeric toolId and a UUID in id.
const url = new URL('https://alterproduct.com/app/model-generator');
url.search = new URLSearchParams({
  embedded: '1',
  lng: 'en',
  parentOrigin: window.location.origin,
  toolId: String(localProject.toolId),
  serverProjectId: localProject.id
}).toString();
// Optional: serverProjectRevision pins an existing saved revision.
iframe.src = url.toString();
// Install the authenticated handshake and storage bridge described below.
// Setting iframe.src alone does not authorize the editor or provide storage.

Zprávy iframe používané propojením ve WordPressu

Plugin WordPress zajišťuje propojení s místním úložištěm a kontroluje oprávnění správce nebo manažera WooCommerce. Ověřuje origin iframe, zdrojové okno, nonce, identifikátor požadavku a povolené cesty projektu. Místní čtení a zápisy směruje na /wp-json/alter-wc/v1/model-generator. Přístupové údaje API zůstávají na serveru. Vlastní integrace musí zajistit rovnocennou autentizovanou obsluhu úložiště; veřejné API generátoru neukládá projekty do Alter Product.

// Messages after ALTER_CHILD_HELLO / ALTER_PARENT_ACK agree on the nonce.
// Iframe -> parent:
const sessionRequest = {
  type: 'ALTER_CUSTOMIZER_INIT_SESSION',
  nonce: handshakeNonce,
  payload: {
    tool: 'model-generator', alterProductId: localProject.toolId, mode: 'edit'
  }
};

// Parent -> iframe, after the server authorizes the merchant and issues a token:
const sessionReady = {
  type: 'ALTER_CUSTOMIZER_SESSION_READY',
  nonce: handshakeNonce,
  token: session.token,
  tool: 'model-generator',
  cartKey: `model-generator:${localProject.id}`,
  mode: 'edit',
  localSession: false,
  adminSession: true
};
// Send only to the validated iframe's exact origin and source window.
// An authorized token and successful bootstrap are still required.

Uložení předává expectedRevision, templateRevision, document a odkazy na artefakty. Vytvoří neměnnou revizi; neaktuální expectedRevision vrátí HTTP 409. WordPress ukládá metadata do své databáze a soubory do adresáře uploads. JSON se minifikuje a komprimuje pomocí gzip, pokud komprese zmenší jeho velikost.

// Example message from the iframe; savedSnapshot and artifact IDs come
// from the generator. The host checks origin/source/nonce/project permissions.
const message = {
  type: 'ALTER_MODEL_GENERATOR_REQUEST',
  requestId: crypto.randomUUID(),
  nonce: handshakeNonce,
  request: {
    method: 'POST',
    path: `/pattern-generator/projects/${projectUuid}/revisions`,
    data: {
      expectedRevision: loadedRevision,
      name: projectName,
      templateRevision,
      document: savedSnapshot,
      references: { artifactIds: savedArtifactIds }
    },
    responseType: 'json'
  }
};

Akce Použít uložený model v návrhu publikuje kompletní uloženou revizi do propojeného návrhu produktu. Zákazníci ji pak vidí ve stávajícím Customizeru, Configuratoru nebo Vieweru se zachováním běžných vazeb produktu a kontrol předplatného. Editor generátoru zůstává nástrojem obchodníka. Odkazy v objednávkách zachovávají uložený projekt a revizi, takže pozdější úpravy automaticky nezmění dřívější objednávky.