API - Zdroje a importy

Procházejte katalog zdrojů, stahujte manifesty a soubory a importujte návrhy.

Přehled koncových bodů

Metoda	Koncový bod	Popis	Přístup
`GET`	`/public-api/v1/assets`	Vypisuje položky katalogu podkladů požadovaného typu.	`libovolné ověřené přístupové údaje`
`GET`	`/public-api/v1/assets/:type/:assetId`	Vrací manifest podkladu s rolemi souborů ke stažení.	`libovolné ověřené přístupové údaje`
`GET`	`/public-api/v1/assets/:type/:assetId/files/:role`	Stahuje soubor podkladu podle role.	`libovolné ověřené přístupové údaje`
`GET`	`/public-api/v1/design-imports`	Vypisuje návrhy hostované v Alter Product, které lze importovat.	`ověřené přístupové údaje, vyžadován tarif Business`
`GET`	`/public-api/v1/design-imports/:id`	Vrací data importu návrhu a popisy souborů.	`ověřené přístupové údaje, vyžadován tarif Business`
`GET`	`/public-api/v1/design-imports/:id/files/:fileId`	Stahuje soubor z popisu importu návrhu.	`ověřené přístupové údaje, vyžadován tarif Business`

Katalog podkladů

Katalog podkladů zpřístupňuje zdrojové podklady produktů, pozadí, prostředí, položky knihovny grafiky, šablony návrhů a podklady mockupů. Koncové body seznamů vracejí stručné popisy; koncové body podrobností obsahují manifesty souborů.

Typ	Popis
`products`	Podklady základních produktů, náhledy, 3D modely, popisy materiálů a textur.
`backgrounds`	Statická pozadí Vieweru.
`environments`	Mapy prostředí a obrázky náhledů.
`image_library`	Podklady knihovny grafiky včetně grafiky omezené na obchod.
`design_templates`	Náhledy šablon návrhů a odkazy na soubory vrstev. Podporuje filtr product_id.
`mockups`	Podklady generátoru mockupů, pozadí a překryvné mapy. Podporuje filtr product_id.

Příklad požadavku (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();

Příklad odpovědi

{
  "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 návrhů

Importy návrhů zpřístupňují návrhy hostované v Alter Product a jejich soubory pro externí výrobu nebo migraci. API ověřuje dostupnost v tarifu Business.

Parametr	Povinné	Podrobnosti
`search`	`ne`	Vyhledává podle názvu nebo ID návrhu.
`offset`	`ne`	Výchozí hodnota 0.
`limit`	`ne`	Výchozí hodnota 20, maximum 100.

Příklad požadavku (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();

Příklad odpovědi

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