API - Zasoby i importy

Przeglądaj katalog zasobów, pobieraj manifesty i pliki oraz importuj projekty.

Przegląd endpointów

Metoda	Endpoint	Opis	Dostęp
`GET`	`/public-api/v1/assets`	Listuje assety katalogu dla wskazanego typu.	`dowolny uwierzytelniony credential`
`GET`	`/public-api/v1/assets/:type/:assetId`	Zwraca manifest assetu z rolami plików do pobrania.	`dowolny uwierzytelniony credential`
`GET`	`/public-api/v1/assets/:type/:assetId/files/:role`	Pobiera plik assetu po roli.	`dowolny uwierzytelniony credential`
`GET`	`/public-api/v1/design-imports`	Listuje designy dostępne do importu.	`uwierzytelniony credential, wymagany plan Business`
`GET`	`/public-api/v1/design-imports/:id`	Zwraca payload importu designu i deskryptory plików.	`uwierzytelniony credential, wymagany plan Business`
`GET`	`/public-api/v1/design-imports/:id/files/:fileId`	Pobiera plik z deskryptora importu designu.	`uwierzytelniony credential, wymagany plan Business`

Katalog assetów

Katalog assetów udostępnia produkty bazowe, tła, środowiska, bibliotekę grafik, szablony designów i assety mockupów. Lista zwraca lekkie deskryptory, a szczegóły zawierają manifest plików.

Typ	Opis
`products`	Assety produktów bazowych, podglądy, modele 3D oraz deskryptory materiałów i tekstur.
`backgrounds`	Statyczne tła viewera.
`environments`	Mapy środowisk i obrazy podglądu.
`image_library`	Assety biblioteki grafik, także grafiki scoped do storefrontu.
`design_templates`	Podglądy szablonów designów i referencje plików warstw. Obsługuje filtr product_id.
`mockups`	Assety generatora mockupów, tła i mapy overlay. Obsługuje filtr product_id.

Przykładowe zapytanie (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();

Przykładowa odpowiedź

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

Importy designów

Importy designów udostępniają designy hostowane w Alter Product oraz ich pliki dla zewnętrznej produkcji lub migracji. API sprawdza dostępność funkcji w planie Business.

Parametr	Wymagany	Szczegóły
`search`	`nie`	Szuka po tytule designu lub ID.
`offset`	`nie`	Domyślnie 0.
`limit`	`nie`	Domyślnie 20, maksymalnie 100.

Przykładowe zapytanie (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();

Przykładowa odpowiedź

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