API - Vue d’ensemble

API - Référence des endpoints

Trouvez un endpoint, la méthode et les autorisations requises, puis consultez un exemple détaillé.

Vue d’ensemble des points d’accès

Le tableau ci-dessous reprend les routes publiques déclarées dans backend-public-api/app.js. Les chemins sont affichés avec le préfixe du proxy public utilisé par les intégrations externes.

MéthodePoint d’accèsDescriptionAccès
GET/public-api/healthzVérification de la disponibilité du service.public
GET/public-api/v1/auth/checkValide les identifiants et renvoie la boutique, les portées et les fonctionnalités de l’offre.tout identifiant authentifié
GET/public-api/v1/customer-ordersRenvoie une liste paginée et filtrable des commandes clients.orders:read
GET/public-api/v1/customer-orders/:idRenvoie une commande client avec ses articles configurés.orders:read
POST/public-api/v1/customer-orders/batchRenvoie jusqu’à 100 commandes par identifiant.orders:read
PATCH/public-api/v1/customer-orders/:id/statusMet à jour le statut de la commande.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantityMet à jour les quantités des lignes de commande sélectionnées.orders:write
PATCH/public-api/v1/customer-orders/:orderId/quantity/allDéfinit une même quantité pour chaque article d’une commande.orders:write
DELETE/public-api/v1/customer-orders/:idSupprime une commande client appartenant au propriétaire de la boutique.orders:write
GET/public-api/v1/productsRenvoie les produits/designs de la boutique avec les possibilités d’intégration et les URL des médias.products:read
GET/public-api/v1/products/:idRenvoie un produit/design de la boutique.products:read
POST/public-api/v1/embed/sessionÉmet un JWT de courte durée pour les outils intégrés, dont le générateur de modèles.embed:session:create
GET/public-api/v1/runtime/bootstrapDétermine le contexte d’exécution à partir d’un JWT d’intégration.jeton d’intégration Bearer
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
GET/public-api/v1/file/public/products/:productId/:sizeRenvoie un aperçu public de produit. La taille doit être small.png, medium.png ou big.png.public
GET/public-api/v1/file/protected/:keyRenvoie un fichier protégé à partir de sa clé de stockage.URL signée ou files:read
GET/public-api/v1/fontsRenvoie toutes les polices disponibles.public
GET/public-api/v1/currenciesRenvoie toutes les devises.public
POST/public-api/v1/runtime-bindings/sync-from-wordpressCrée ou met à jour les associations d’exécution à partir des associations de produits WordPress.tout identifiant authentifié
PATCH/public-api/v1/runtime-bindings/:idModifie une association d’exécution.tout identifiant authentifié
POST/public-api/v1/runtime-bindings/:id/activateActive une association d’exécution.tout identifiant authentifié
POST/public-api/v1/runtime-bindings/:id/deactivateDésactive une association d’exécution.tout identifiant authentifié
POST/public-api/v1/wp-connect/exchangeÉchange un code de transfert de connexion automatique WordPress contre des identifiants API.code de transfert à usage unique
GET/public-api/v1/model-generator/catalogListe les produits du générateur, les configurations et les révisions de gabarits visibles.embed:session:create
GET/public-api/v1/model-generator/modelsListe les modèles avec des descripteurs de sources du générateur liés à des révisions précises pour l’import.embed:session:create
GET/public-api/v1/model-generator/designer-catalogRenvoie le catalogue de modèles du générateur utilisé par Designer.embed:session:create
GET/public-api/v1/model-generator/projectsListe les projets du générateur appartenant au propriétaire et ceux disponibles globalement.embed:session:create
GET/public-api/v1/model-generator/projects/:projectIdRenvoie la révision la plus récente ou sélectionnée du projet, le gabarit et le manifeste des fichiers.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/revisions/:revisionRenvoie la révision la plus récente ou sélectionnée du projet, le gabarit et le manifeste des fichiers.embed:session:create
GET/public-api/v1/model-generator/projects/:projectId/artifacts/:artifactIdTélécharge un artefact après vérification de l’accès à son projet.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/templateRenvoie un document de gabarit accessible pour la révision de configuration sélectionnée.embed:session:create
GET/public-api/v1/model-generator/configurations/:configurationId/revisions/:revision/importRenvoie le paquet d’import du gabarit avec les fichiers de dépendances.embed:session:create
GET/public-api/v1/model-generator/mannequinsRenvoie les deux mannequins et les descripteurs de leurs ressources.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assetsListe les ressources des bibliothèques de textures ou d’arrière-plans avec les fichiers importables.embed:session:create
GET/public-api/v1/model-generator/image-libraries/:kind/assets/:assetIdRenvoie une ressource de texture ou d’arrière-plan avec ses fichiers importables.embed:session:create
GET/public-api/v1/model-generator/public-files/:keyTélécharge un fichier de dépendance autorisé du générateur.embed:session:create