Vuforia Studio Product API
Introduction
This section introduces the key components that enable you to build scalable, data-independent experiences that support a wide range of product definitions. The Product API allows you to:
• Generate product definitions for multiple products, indexed by a user-defined product ID and version
• Upload and simplify 3D models for each product
• Generate reusable Model Targets based on the stored models on the Experience Service
In addition, the Product API supports:
• Downloading generated assets (such as simplified models or Model Targets) to external storage locations
• Dynamically using stored product data in any experience through the Product widget, Dynamic Target widget, and Model widget
Use the Product API to streamline your workflow, reduce duplication, and deliver flexible, reusable AR experiences across your product portfolio.
Explore the following use cases to gain a deeper understanding of the API and its application in various scenarios.
Access the API Documentation (Swagger)
You can access the API on your Experience Service using the following URL:
https://<your_es>/ExperienceService/api-docs
 |
You must be a valid Experience Service user and be logged in to access the API documentation.
|
Disable the API and API Documentation
The Product API is enabled by default. If needed, you can disable it by updating the Experience Service configuration:
1. As an administrator, open the directory in which the Experience Service was installed (for example, C:\ptc).
2. Open the configuration.json file. This file is usually located at the root of the PTC folder.
3. Change enableProductsAPI to false:
"enableProductsAPI": false,
4. Restart the Experience Service.
You can also disable access to the API documentation by adding the following to the configuration.json file:
"enableSwagger": false,