Ενσωμάτωση Public API του Alter Product

Έλεγχος ταυτότητας και βασικό URL

https://alterproduct.com/public-api/v1

Δημιουργήστε διαπιστευτήρια API στις ρυθμίσεις ηλεκτρονικού εμπορίου. Το Access Token εμφανίζεται μία φορά, οπότε αποθηκεύστε το αμέσως στο ασφαλές αποθετήριο μυστικών του backend.

Κρατήστε τα Access Key και Access Token στον διακομιστή σας. Τα endpoints με έλεγχο ταυτότητας απορρίπτουν κλήσεις από προγράμματα περιήγησης που περιλαμβάνουν κεφαλίδες Origin ή Referer.

Τα διαπιστευτήρια μπορούν να έχουν περιορισμένα δικαιώματα. Χρησιμοποιήστε GET /auth/check για να επαληθεύσετε το ενεργό κατάστημα, τις δυνατότητες προγράμματος και τα δικαιώματα που επιστρέφονται για τα διαπιστευτήρια.

x-alter-access-key: YOUR_API_KEY
x-alter-access-token: YOUR_API_TOKEN

Δοκιμή σύνδεσης

Χρησιμοποιήστε το endpoint ελέγχου ταυτότητας πριν ενεργοποιήσετε λειτουργίες συγχρονισμού ή ενσωμάτωσης σε παραγωγική εγκατάσταση.

GET https://alterproduct.com/public-api/v1/auth/check

Παράδειγμα αιτήματος (fetch)

const response = await fetch('https://alterproduct.com/public-api/v1/auth/check', {
  method: 'GET',
  headers: {
    'x-alter-access-key': process.env.ALTER_ACCESS_KEY,
    'x-alter-access-token': process.env.ALTER_ACCESS_TOKEN
  }
});

const payload = await response.json();

if (!response.ok) {
  throw new Error(payload?.code || payload?.error || `Alter API ${response.status}`);
}

console.log(payload);

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

{
  "ok": true,
  "message": "success",
  "storefrontId": 12,
  "userOwnerId": 34,
  "credentialId": 56,
  "scopes": ["orders:read", "orders:write", "products:read"],
  "plan": {
    "requiredPlan": "Business",
    "currentPlanName": "Business",
    "eligible": true,
    "runtimeFlags": {
      "viewer": true,
      "configurator": true,
      "customizer": true
    },
    "limits": {
      "activeRuntimeBindingsLimit": 100,
      "monthlyReassignmentLimit": 1000,
      "monthlyEmbedTokenLimit": 50000
    }
  }
}

Η παρακάτω βοηθητική συνάρτηση χρησιμοποιείται στα υπόλοιπα παραδείγματα. Είναι απλό fetch και εκτελείται σε Node.js 18+ ή οποιοδήποτε περιβάλλον διακομιστή παρέχει fetch.

const ALTER_API_BASE = 'https://alterproduct.com/public-api/v1';

const authHeaders = {
  'x-alter-access-key': process.env.ALTER_ACCESS_KEY,
  'x-alter-access-token': process.env.ALTER_ACCESS_TOKEN
};

async function alterFetch(path, options = {}) {
  const response = await fetch(`${ALTER_API_BASE}${path}`, {
    ...options,
    headers: {
      ...authHeaders,
      ...(options.body ? { 'Content-Type': 'application/json' } : {}),
      ...options.headers
    }
  });

  const payload = await response.json().catch(() => null);

  if (!response.ok) {
    throw new Error(payload?.code || payload?.error || `Alter API ${response.status}`);
  }

  return payload;
}

Επισκόπηση endpoints

Ο πίνακας παρακάτω αντιστοιχεί στις δημόσιες διαδρομές του backend-public-api/app.js. Οι διαδρομές εμφανίζονται με το πρόθεμα δημόσιου proxy που χρησιμοποιούν οι εξωτερικές ενσωματώσεις.

Παραγγελίες πελατών

Τα endpoints παραγγελιών επιτρέπουν σε εξωτερικό κατάστημα να διαβάζει διαμορφωμένα στοιχεία, να ενημερώνει ποσότητες, να μετακινεί παραγγελίες σε καταστάσεις εκτέλεσης και να αφαιρεί εγκαταλελειμμένες παραγγελίες.

Παράδειγμα αιτήματος (fetch)

const params = new URLSearchParams({
  limit: '20',
  offset: '0',
  order_status: 'shopping_cart',
  order_by: 'created_at',
  direction: 'DESC'
});

const orders = await alterFetch(`/customer-orders?${params.toString()}`);

const order = await alterFetch('/customer-orders/123');

const batch = await alterFetch('/customer-orders/batch', {
  method: 'POST',
  body: JSON.stringify({
    customerOrderIds: [123, 124, 125]
  })
});

Επιτρεπόμενες τιμές

Παράδειγμα αιτήματος (fetch)

await alterFetch('/customer-orders/123/status', {
  method: 'PATCH',
  body: JSON.stringify({
    status: 'processing'
  })
});

await alterFetch('/customer-orders/123/quantity', {
  method: 'PATCH',
  body: JSON.stringify({
    items: [
      { orderDetailId: 987, quantity: 3 }
    ]
  })
});

await alterFetch('/customer-orders/123/quantity/all', {
  method: 'PATCH',
  body: JSON.stringify({
    quantity: 2
  })
});

await alterFetch('/customer-orders/123', {
  method: 'DELETE'
});

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

{
  "order": {
    "id": 123,
    "customizerId": 381,
    "orderStatus": "shopping_cart",
    "createdAt": "2026-05-28T10:15:00.000Z",
    "customizerOrderURL": "https://alterproduct.com/app/customizer/381/123",
    "productItems": [
      {
        "id": 987,
        "model3d": { "id": 381 },
        "size": {
          "id": 395,
          "name": { "pl": "M", "en": "M" },
          "measureSize": null
        },
        "material": {
          "id": 2,
          "name": { "pl": "Bawełna", "en": "Cotton" }
        },
        "printType": {
          "id": 1,
          "name": { "pl": "DTG", "en": "DTG" }
        },
        "color": {
          "id": 418,
          "name": { "pl": "Domyślny", "en": "Default" },
          "hex": "#ffffff"
        },
        "variant": {
          "id": 531,
          "metadata": null,
          "stockQuantity": 25
        },
        "unitPrice": { "value": 12.5, "currency": "EUR" },
        "totalPrice": { "value": 37.5, "currency": "EUR" },
        "quantity": 3
      }
    ],
    "customizerName": "Men's T-Shirt",
    "productGroup": {
      "id": 4,
      "name": { "pl": "Koszulka", "en": "T-Shirt" }
    },
    "totalPrice": { "value": 37.5, "currency": "EUR" }
  }
}

Προϊόντα καταστήματος

Τα endpoints προϊόντων επιστρέφουν σχέδια καταστήματος που μπορούν να ενσωματωθούν ως Viewer, Configurator ή Customizer.

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

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

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

Συνεδρίες ενσωμάτωσης και αρχική φόρτωση περιβάλλοντος εκτέλεσης

Δημιουργήστε βραχύβιο token ενσωμάτωσης στον διακομιστή, περάστε το στο iframe/περιβάλλον εκτέλεσης και αφήστε το περιβάλλον να καλέσει bootstrap με token Bearer.

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

Σημειώσεις

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
  })
});

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

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

Γεννήτρια μοντέλων 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 the alterFetch helper and authHeaders defined above.
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, με τις συνήθεις συνδέσεις προϊόντων και τους ελέγχους συνδρομής. Ο επεξεργαστής της γεννήτριας παραμένει εργαλείο του εμπόρου. Οι σύνδεσμοι των παραγγελιών διατηρούν το αποθηκευμένο έργο και την αναθεώρηση, ώστε οι μεταγενέστερες αλλαγές να μην τροποποιούν αυτόματα παλαιότερες παραγγελίες.

Κατάλογος πόρων

Ο κατάλογος πόρων παρέχει πηγαίους πόρους προϊόντων, φόντα, περιβάλλοντα, στοιχεία γραφικής βιβλιοθήκης, πρότυπα σχεδίων και πόρους μακετών. Τα endpoints λίστας επιστρέφουν συνοπτικές περιγραφές· τα endpoints λεπτομερειών περιλαμβάνουν manifests αρχείων.

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

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

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

Εισαγωγές σχεδίων

Οι εισαγωγές σχεδίων παρέχουν πρόσβαση σε σχέδια και αρχεία που φιλοξενούνται στο Alter για εξωτερική παραγωγή ή μεταφορά δεδομένων. Το API ελέγχει αν πληρούνται οι προϋποθέσεις του προγράμματος Business.

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

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

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

Αρχεία, γραμματοσειρές και νομίσματα

Τα δημόσια αρχεία προεπισκόπησης είναι κατάλληλα για προγράμματα περιήγησης. Τα προστατευμένα αρχεία απαιτούν υπογεγραμμένο URL ή διαπιστευτήρια API με files:read. Οι γραμματοσειρές και τα νομίσματα έχουν δημόσια endpoints ανάγνωσης.

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

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

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

Συνδέσεις περιβάλλοντος εκτέλεσης

Οι συνδέσεις περιβάλλοντος εκτέλεσης συνδέουν εξωτερικά εμπορικά προϊόντα με σχέδια Alter Product και τύπους εργαλείων. Χρησιμοποιούνται κυρίως από ενσωματώσεις WordPress/WooCommerce και προηγμένα backend καταστημάτων.

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

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

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

Ανταλλαγή σύνδεσης WordPress

Το endpoint ανταλλαγής σύνδεσης WordPress καταναλώνει κωδικό μεταβίβασης μίας χρήσης και επιστρέφει διαπιστευτήρια API στο πρόσθετο. Δεν αποτελεί endpoint γενικής δημιουργίας διαπιστευτηρίων.

Παράδειγμα αιτήματος (fetch)

const response = await fetch('https://alterproduct.com/public-api/v1/wp-connect/exchange', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    code: 'ONE_TIME_HANDOFF_CODE',
    storeUrl: 'https://yourstore.com/',
    siteOrigin: 'https://yourstore.com',
    codeVerifier: 'PKCE_CODE_VERIFIER_32_TO_128_CHARS'
  })
});

const credentials = await response.json();

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

{
  "message": "wpConnect.exchange.ok",
  "accessKey": "generated-access-key",
  "accessToken": "generated-access-token",
  "storefrontId": 12
}

Σφάλματα και όρια ρυθμού αιτημάτων

Τα περισσότερα σφάλματα ελεγκτών κανονικοποιούνται σε απάντηση code. Το middleware ελέγχου ταυτότητας και οι περιοριστές ρυθμού μπορούν να επιστρέφουν απάντηση error.

// Controller error
{
  "code": "assetCatalog.invalidType"
}

// Auth middleware or rate limit
{
  "error": "Unauthorized"
}

{
  "error": "Too Many Requests"
}