API - Vue d’ensemble

API - Ressources et imports

Parcourez le catalogue de ressources, récupérez les manifestes et les fichiers, et importez des projets.

Vue d’ensemble des points d’accès

MéthodePoint d’accèsDescriptionAccès
GET/public-api/v1/assetsListe les éléments du catalogue de ressources du type demandé.tout identifiant authentifié
GET/public-api/v1/assets/:type/:assetIdRenvoie le manifeste d’une ressource avec les rôles de ses fichiers téléchargeables.tout identifiant authentifié
GET/public-api/v1/assets/:type/:assetId/files/:roleTélécharge un fichier de ressource selon son rôle.tout identifiant authentifié
GET/public-api/v1/design-importsListe les designs hébergés chez Alter pouvant être importés.identifiant authentifié, offre Business requise
GET/public-api/v1/design-imports/:idRenvoie les données d’import d’un design et les descripteurs de fichiers.identifiant authentifié, offre Business requise
GET/public-api/v1/design-imports/:id/files/:fileIdTélécharge un fichier à partir d’un descripteur d’import de design.identifiant authentifié, offre Business requise

Catalogue de ressources

Le catalogue de ressources expose les ressources sources des produits, les arrière-plans, les environnements, les éléments de la bibliothèque graphique, les modèles de design et les ressources des maquettes. Les points d’accès de liste renvoient des descripteurs légers ; ceux de détail incluent les manifestes des fichiers.

TypeDescription
productsRessources de produits de base, aperçus, modèles 3D, descripteurs de matériaux et de textures.
backgroundsArrière-plans statiques de Viewer.
environmentsCartes d’environnement et images d’aperçu.
image_libraryRessources de la bibliothèque graphique, y compris les images propres à la boutique.
design_templatesAperçus des modèles de design et références des fichiers de calques. Prend en charge le filtre product_id.
mockupsRessources du générateur de maquettes, arrière-plans et cartes de superposition. Prend en charge le filtre product_id.

Exemple de requête (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();

Exemple de réponse

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

Imports de designs

Les imports de designs donnent accès aux designs hébergés chez Alter et à leurs fichiers pour les processus de production ou de migration externes. L’API vérifie l’éligibilité à l’offre Business.

ParamètreObligatoireDétails
searchnonRecherche le titre ou l’identifiant du design.
offsetnonValeur par défaut : 0.
limitnonValeur par défaut : 20, maximum : 100.

Exemple de requête (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();

Exemple de réponse

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