Web SDK Reference

Reference docs for each of the full list of methods and functions available in the SDK.

Initialization methods

Method	Description
.canVisualizeForBrowser()	Checks if browser compatibility to visualize the web configurator.
.getAvailableProducts()	Returns a list of available products to load in the web configurator.
.createContext()	Used to initialize and setup the SDK. All other SDK methods must be called after this one.
.createContextFromConfiguration	Used to initialize from an existing configuration and setup the SDK. All other SDK methods must be called after this one.
.checkConfiguration()	Check the validity of an existing configuration.

Context methods

Method	Description
.Context.setValue()	Sets the value of a parameter.
.Context.save()	Saves the current parameters with their values to a remote storage.
.Context.setEnvironment()	Set a predefined 3D scene environment.
.Context.renderPreview()	Render a preview image of the 3D scene.

Static views methods

Method	Description
.Context.staticViews.getViews()	Get a list of static views that are defined on a product template.
.Context.staticViews.getImage()	Get an image of the product, given a static view.

HTTP API

Additional functionality for saving a product configuration, creating and retrieving orders, verifying payment information and more can be used through the available HTTP API.

System	API documentation	Description
Order service	API documentation	Everything related to orders and order data.
Configuration service	Configuration service - API documentation	Store and retrieve product configurations.
Web plugin service (legacy)	Web SDK Reference - HTTP API web plugin service (legacy)	Create orders, retrieve order information and verify payments (legacy).