API - 概要

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-importsAlter でホストされているインポート可能なデザインを一覧表示します。認証済み認証情報、Business プランが必要
GET/public-api/v1/design-imports/:idデザインのインポートペイロードとファイルの記述情報を返します。認証済み認証情報、Business プランが必要
GET/public-api/v1/design-imports/:id/files/:fileIdデザインのインポート記述情報からファイルをダウンロードします。認証済み認証情報、Business プランが必要

アセットカタログ

アセットカタログは、商品のソースアセット、背景、環境、グラフィックライブラリの項目、デザインテンプレート、モックアップ用アセットを提供します。一覧エンドポイントは軽量な記述情報を返し、詳細エンドポイントにはファイルマニフェストが含まれます。

型説明
products基本の商品アセット、プレビュー、3D モデル、素材とテクスチャの記述情報。
backgroundsViewer の静止背景。
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 でホストされているデザインとそのファイルを取得できます。Business プランの利用資格は API で確認されます。

パラメータ必須詳細
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
}