API - अवलोकन

API - संसाधन और इम्पोर्ट

संसाधन कैटलॉग देखें, मैनिफ़ेस्ट और फ़ाइलें डाउनलोड करें और डिज़ाइन इम्पोर्ट करें।

एंडपॉइंट का अवलोकन

विधिएंडपॉइंटविवरणऐक्सेस
GET/public-api/v1/assetsमाँगे गए प्रकार के एसेट कैटलॉग आइटम की सूची देता है।कोई भी प्रमाणित क्रेडेंशियल
GET/public-api/v1/assets/:type/:assetIdडाउनलोड की जा सकने वाली फ़ाइल भूमिकाओं वाला एसेट मैनिफ़ेस्ट लौटाता है।कोई भी प्रमाणित क्रेडेंशियल
GET/public-api/v1/assets/:type/:assetId/files/:roleभूमिका के आधार पर एसेट फ़ाइल डाउनलोड करता है।कोई भी प्रमाणित क्रेडेंशियल
GET/public-api/v1/design-importsAlter पर होस्ट किए गए आयात योग्य डिज़ाइन की सूची देता है।प्रमाणित क्रेडेंशियल, Business योजना आवश्यक
GET/public-api/v1/design-imports/:idडिज़ाइन आयात का पेलोड और फ़ाइल विवरण लौटाता है।प्रमाणित क्रेडेंशियल, Business योजना आवश्यक
GET/public-api/v1/design-imports/:id/files/:fileIdडिज़ाइन आयात विवरण से फ़ाइल डाउनलोड करता है।प्रमाणित क्रेडेंशियल, Business योजना आवश्यक

एसेट कैटलॉग

एसेट कैटलॉग उत्पाद के स्रोत एसेट, पृष्ठभूमि, परिवेश, ग्राफ़िक लाइब्रेरी आइटम, डिज़ाइन टेम्पलेट और मॉकअप एसेट उपलब्ध कराता है। सूची एंडपॉइंट हल्के विवरण लौटाते हैं; विस्तृत एंडपॉइंट में फ़ाइल मैनिफ़ेस्ट होते हैं।

प्रकारविवरण
productsमूल उत्पाद एसेट, प्रीव्यू, 3D मॉडल तथा सामग्री और टेक्सचर विवरण।
backgroundsव्यूअर की स्थिर पृष्ठभूमियाँ।
environmentsपरिवेश मैप और प्रीव्यू चित्र।
image_libraryग्राफ़िक लाइब्रेरी एसेट, जिनमें स्टोरफ़्रंट-विशिष्ट ग्राफ़िक्स भी शामिल हैं।
design_templatesडिज़ाइन टेम्पलेट प्रीव्यू और लेयर फ़ाइल संदर्भ। product_id फ़िल्टर समर्थित है।
mockupsमॉकअप जनरेटर एसेट, पृष्ठभूमि और ओवरले मैप। product_id फ़िल्टर समर्थित है।

उदाहरण अनुरोध (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 योजना की पात्रता जाँचती है।

पैरामीटरआवश्यकविवरण
searchनहींडिज़ाइन के शीर्षक या ID से खोजता है।
offsetनहींडिफ़ॉल्ट 0।
limitनहींडिफ़ॉल्ट 20, अधिकतम 100।

उदाहरण अनुरोध (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
}