Iframe embedding is only available for ShapeDiver users with a paid subscription.

In the “Embedding” section of the model edit page, you have the ability to enable embedding for the ShapeDiver model. It is necessary to enable embedding in two cases:

  • Embed a model in an external website using the iframe embedding feature.

  • Embed a model in an external website using the viewer API.

Simply check the “Allow embedding” box to enable embedding.

Iframe embedding

In order to use the iframe feature, simply save the settings and go back to the model view page, where you will have access to the iframe options and the ability to copy the full iframe code for your website.

Direct embedding using the viewer API

Once the box is checked, three elements are displayed in the section:

  • An embedding ticket

  • The model view URL, which indicates which backend system is hosting the model. ShapeDiver uses several geometry backend systems and it is important to specify which one hosts your model when using the viewer API.

  • As a read-only information, the domains you have whitelisted for embedding are displayed on the right.

You can copy the ticket and the model view URL and use them with the viewer API to build a custom web application. The simple example on this page clearly shows where to use both elements in order to start a session to your model.

Once you have allowed embedding for your model, make sure you have set up domains for embedding in your account settings.

The embedding ticket can only be used to open a session with the model using the viewer API. In order to communicate with the model in a headless context (applications that do not run in the web browser), you will need to enable backend access and use the ticket for backend access.