API - Recursos e importações

Explore o catálogo de recursos, obtenha manifestos e arquivos e importe projetos.

Visão geral dos endpoints

Método	Endpoint	Descrição	Acesso
`GET`	`/public-api/v1/assets`	Lista os itens do catálogo de recursos do tipo solicitado.	`qualquer credencial autenticada`
`GET`	`/public-api/v1/assets/:type/:assetId`	Retorna um manifesto de recurso com as funções dos arquivos disponíveis para download.	`qualquer credencial autenticada`
`GET`	`/public-api/v1/assets/:type/:assetId/files/:role`	Baixa um arquivo de recurso pela função.	`qualquer credencial autenticada`
`GET`	`/public-api/v1/design-imports`	Lista os designs hospedados no Alter disponíveis para importação.	`credencial autenticada, plano Business obrigatório`
`GET`	`/public-api/v1/design-imports/:id`	Retorna um payload de importação de design e descritores de arquivos.	`credencial autenticada, plano Business obrigatório`
`GET`	`/public-api/v1/design-imports/:id/files/:fileId`	Baixa um arquivo a partir de um descritor de importação de design.	`credencial autenticada, plano Business obrigatório`

Catálogo de recursos

O catálogo de recursos disponibiliza os recursos originais dos produtos, fundos, ambientes, itens da biblioteca de imagens, modelos de design e recursos de mockup. Os endpoints de listagem retornam descritores leves; os endpoints de detalhes incluem manifestos de arquivos.

Tipo	Descrição
`products`	Recursos base do produto, prévias, modelos 3D e descritores de materiais e texturas.
`backgrounds`	Fundos estáticos do Viewer.
`environments`	Mapas de ambiente e imagens de prévia.
`image_library`	Recursos da biblioteca de imagens, incluindo imagens restritas à loja.
`design_templates`	Prévias de modelos de design e referências a arquivos de camadas. Aceita o filtro product_id.
`mockups`	Recursos do gerador de mockups, fundos e mapas de sobreposição. Aceita o filtro product_id.

Exemplo de solicitação (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();

Exemplo de resposta

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

Importações de designs

As importações de designs disponibilizam designs hospedados no Alter e seus arquivos para fluxos externos de produção ou migração. A API verifica a elegibilidade do plano Business.

Parâmetro	Obrigatório	Detalhes
`search`	`não`	Pesquisa pelo título ou ID do design.
`offset`	`não`	Padrão 0.
`limit`	`não`	Padrão 20, máximo 100.

Exemplo de solicitação (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();

Exemplo de resposta

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