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`	Базові ресурси товарів, зображення перегляду, 3D-моделі, описи матеріалів і текстур.
`backgrounds`	Статичні фони Viewer.
`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
}