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-importsسرد التصاميم المستضافة لدى Alter والمتاحة للاستيراد.بيانات اعتماد تمت مصادقتها، تتطلب خطة Business
GET/public-api/v1/design-imports/:idإعادة حمولة استيراد تصميم وأوصاف الملفات.بيانات اعتماد تمت مصادقتها، تتطلب خطة Business
GET/public-api/v1/design-imports/:id/files/:fileIdتنزيل ملف من وصف استيراد تصميم.بيانات اعتماد تمت مصادقتها، تتطلب خطة Business

كتالوج الأصول

يتيح كتالوج الأصول الوصول إلى أصول المنتجات المصدرية والخلفيات والبيئات وعناصر مكتبة الرسومات وقوالب التصميم وأصول النماذج التسويقية. تعيد نقاط نهاية القوائم أوصافًا خفيفة، بينما تتضمن نقاط نهاية التفاصيل بيانات الملفات.

النوعالوصف
productsأصول المنتجات الأساسية والمعاينات والنماذج ثلاثية الأبعاد وأوصاف الخامات والأنسجة.
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 Product وملفاتها لمسارات الإنتاج الخارجية أو الترحيل. تتحقق API من الأهلية بحسب خطة Business.

المعلمةمطلوبالتفاصيل
searchلاالبحث بعنوان التصميم أو معرّفه.
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
}