API - Γεννήτρια μοντέλων 3D

Γεννήτρια μοντέλων 3D

Τα endpoints εισαγωγής της γεννήτριας δέχονται μόνο αιτήματα ανάγνωσης μεταξύ διακομιστών. Απαιτούν τις τυπικές κεφαλίδες API, το δικαίωμα embed:session:create και ενεργό πρόγραμμα. Η εξουσιοδότηση εισαγωγής δεν δημιουργεί συνεδρία επεξεργασίας και δεν καταναλώνει το μηνιαίο όριό της. Το άνοιγμα του επεξεργαστή χρησιμοποιεί τον ίδιο μετρητή monthlyEmbedTokenLimit με τα υπόλοιπα ενσωματωμένα εργαλεία.

Εύρεση και εισαγωγή μοντέλων με γεννήτρια

Χρησιμοποιήστε το /model-generator/models για να εμφανίσετε τα διαθέσιμα μοντέλα με γεννήτριες. Ο περιγραφέας generator καθορίζει συγκεκριμένα projectId, revision, configurationId, templateRevision, productId και productModel3dId. Ακολουθήστε το importPath του για να ανακτήσετε ακριβώς αυτήν την αναθεώρηση προέλευσης. Τα manifests πόρων προϊόντων παρέχουν επίσης το generators και τον περιγραφέα generator κάθε μοντέλου. Τα πρότυπα μπορούν να εισαχθούν ξεχωριστά, βάσει διαμόρφωσης και αναθεώρησης.

Φίλτρα καταλόγων

Η εισαγωγή ενός έργου περιέχει document, revision, template και ένα manifest files. Κάθε αρχείο παρέχει ένα path κάτω από το /v1/model-generator/· προσθέστε μπροστά του το /public-api κατά τη λήψη από το Alter Product. Αντιγράψτε τα απαραίτητα αρχεία στον δικό σας χώρο αποθήκευσης και αντικαταστήστε τις αναφορές προέλευσης με τοπικές αναφορές. Εισαγάγετε τις κούκλες και τις βιβλιοθήκες υφών μέσω των αντίστοιχων endpoints καταλόγου· το public-files περιορίζεται σε επιτρεπόμενες διαδρομές πόρων και τα πρότυπα πρέπει να περνούν τους ελέγχους πρόσβασης διαμόρφωσης και αναθεώρησης.

Παράδειγμα αιτήματος (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 });

Συνεδρία επεξεργαστή και τοπική αποθήκευση

Δημιουργήστε τη συνεδρία επεξεργαστή με tool: model-generator, ένα θετικό αριθμητικό toolId που προσδιορίζει το τοπικό έργο της γεννήτριας (όχι το UUID του ούτε το ID προϊόντος WooCommerce) και το επιτρεπόμενο origin του καταστήματος. Μη μεταβιβάζετε designId, orderId, runtimeBindingId ή πεδία καλαθιού για αυτό το εργαλείο. Το UUID του έργου της γεννήτριας είναι ξεχωριστό αναγνωριστικό. Μεταβιβάστε το token που επιστρέφεται μέσω του handshake iframe· το runtime bootstrap επιστρέφει το περιβάλλον της γεννήτριας με 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);

Παράδειγμα απάντησης

{
  "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.

Μηνύματα iframe που χρησιμοποιεί η γέφυρα WordPress

Το πρόσθετο WordPress φιλοξενεί τη γέφυρα αποθήκευσης και ελέγχει τα δικαιώματα διαχειριστή ή υπευθύνου WooCommerce. Επαληθεύει το origin του iframe, το παράθυρο προέλευσης, το nonce, το αναγνωριστικό αιτήματος και τις επιτρεπόμενες διαδρομές του έργου. Η γέφυρα στέλνει τις τοπικές αναγνώσεις και εγγραφές στο /wp-json/alter-wc/v1/model-generator. Τα διαπιστευτήρια API παραμένουν στον διακομιστή. Μια προσαρμοσμένη ενσωμάτωση πρέπει να υλοποιεί ισοδύναμη διαχείριση αποθήκευσης με έλεγχο ταυτότητας· το δημόσιο API της γεννήτριας δεν αποθηκεύει έργα στο 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.

Η αποθήκευση παρέχει expectedRevision, templateRevision, document και αναφορές σε τεχνουργήματα. Δημιουργεί μια αμετάβλητη αναθεώρηση· ένα μη ενημερωμένο expectedRevision επιστρέφει HTTP 409. Το WordPress αποθηκεύει τα μεταδεδομένα στη βάση δεδομένων του και τα αρχεία στον κατάλογο uploads. Το JSON ελαχιστοποιείται και συμπιέζεται με gzip, όταν η συμπίεση μειώνει το μέγεθός του.

// 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'
  }
};

Η ενέργεια Χρήση αποθηκευμένου μοντέλου σε σχέδιο δημοσιεύει μια πλήρη αποθηκευμένη αναθεώρηση σε ένα συνδεδεμένο σχέδιο. Οι πελάτες τη βλέπουν στη συνέχεια μέσω του υπάρχοντος Customizer, Configurator ή Viewer, με τις συνήθεις συνδέσεις προϊόντων και τους ελέγχους συνδρομής. Ο επεξεργαστής της γεννήτριας παραμένει εργαλείο του εμπόρου. Οι σύνδεσμοι των παραγγελιών διατηρούν το αποθηκευμένο έργο και την αναθεώρηση, ώστε οι μεταγενέστερες αλλαγές να μην τροποποιούν αυτόματα παλαιότερες παραγγελίες.