API reference¶
Licensing
Access to the APIs documented in this section is granted to licensees of the Viewer SDK tier only. i.e., access to the API is not included in the ESSENTIAL, PRO, or PRO+ subscriptions. If the Viewer SDK tier fits your project, subscribe or contact us and we will help you choose.
The Viewer SDK is ideal when you want full control over the deployment. Two examples:
- Host the content on your own infrastructure, which is a natural fit when your catalog spans a large inventory of models, materials, and design options.
- Build an embedded integration in your website under your own identity: the viewer connected to your inventory, prices updating as the customer selects metals and stones, and the viewer and the dynamic elements of your page responding to each other.
As a proof of concept, catalog.maverickexcelsior.com is a mockup webshop built exactly this way. Every product page embeds the viewer woven into an assortment of beauty shots, with materials, stone types, and prices wired into the page.
Documentation¶
The API reference is organized into focused guides and inventories:
-
Viewer SDK
Drive an embedded viewer from JavaScript: authentication, scene lifecycle, controls, and events.
-
Property inventory
Every settable scene property: globals, camera, render pipeline, animation, and per-layer materials.
-
Event inventory
Stable Viewer SDK lifecycle and error events, their payloads, and listener methods.
-
Library inventory
The exact, case-correct names of every built-in material and lighting preset.
-
Command-line Interface (CLI)
Industrial-strength batch-render automation for Windows.
If you prefer to learn from running code, the working examples cover self-hosting, jsDelivr, ES modules, iframe sharing, two configurator architectures and generated geometry.