API - Genel bakış

API - Kaynaklar ve içe aktarma

Kaynak kataloğuna göz atın, manifest ve dosyaları indirin, tasarımları içe aktarın.

Uç noktalara genel bakış

YöntemUç noktaAçıklamaErişim
GET/public-api/v1/assetsİstenen türdeki varlık kataloğu öğelerini listeler.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/assets/:type/:assetIdİndirilebilir dosya rolleri içeren varlık manifesti döndürür.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/assets/:type/:assetId/files/:roleRolüne göre varlık dosyası indirir.kimliği doğrulanmış herhangi bir kimlik bilgisi
GET/public-api/v1/design-importsAlter’da barındırılan, içe aktarılabilir tasarımları listeler.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir
GET/public-api/v1/design-imports/:idTasarım içe aktarma verilerini ve dosya tanımlayıcılarını döndürür.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir
GET/public-api/v1/design-imports/:id/files/:fileIdTasarım içe aktarma tanımlayıcısındaki dosyayı indirir.kimliği doğrulanmış kimlik bilgisi, Business planı gerekir

Varlık kataloğu

Varlık kataloğu ürün kaynak varlıklarını, arka planları, ortamları, grafik kütüphanesi öğelerini, tasarım şablonlarını ve maket varlıklarını sunar. Liste uç noktaları hafif tanımlayıcılar, ayrıntı uç noktaları ise dosya manifestleri döndürür.

TürAçıklama
productsTemel ürün varlıkları, önizlemeler, 3D modeller, malzeme ve doku tanımlayıcıları.
backgroundsSabit Viewer arka planları.
environmentsOrtam haritaları ve önizleme görselleri.
image_libraryMağazaya özel grafikler dahil grafik kütüphanesi varlıkları.
design_templatesTasarım şablonu önizlemeleri ve katman dosyası referansları. product_id filtresini destekler.
mockupsMaket oluşturucu varlıkları, arka planları ve kaplama haritaları. product_id filtresini destekler.

Örnek istek (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();

Örnek yanıt

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

Tasarım içe aktarımları

Tasarım içe aktarımları, dış üretim veya taşıma akışları için Alter’da barındırılan tasarımları ve dosyalarını sunar. API, Business planı uygunluğunu kontrol eder.

ParametreGerekliAyrıntılar
searchhayırTasarım başlığı veya kimliğinde arama yapar.
offsethayırVarsayılan 0.
limithayırVarsayılan 20, en fazla 100.

Örnek istek (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();

Örnek yanıt

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