54321G
Liftmira
HomeArticleAboutContactDocs

Getting started

Getting started with Liftmira on your website

The three steps from a new account to a live 3D viewer, what runs on your website, your server and Comnoira, and how to try a Showcase before your shop is activated.

Liftmira runs on the Comnoira platform. On your page, a script called the Comnoira SDK opens the 3D viewer in an iframe. The viewer shows one Showcase: a set of products and options you configured in the Comnoira Dashboard. This guide covers the order of work. The next guides cover each part in detail.

The three steps

Going from sign-up to a live viewer takes three steps. Step 2 has one condition, noted below the list.

  1. Create your account. You sign up and set up your shop in the Dashboard.
  2. Get your embed code and License key. The Dashboard gives you the code for your page and a License key that identifies your shop.
  3. Send your product information. You send images, drawings or a catalogue of your cabin models, and the Liftmira team builds the interactive 3D model that appears on your website.

A License key and the production code are issued when Comnoira activates your shop. Until then the Dashboard offers a Preview, described further down.

From sign-up to a live viewer

Three steps: create an account, get the embed code and License key, send your product information.

  1. 1 Step

    Create your account

    Sign up and set up your shop in the Dashboard.

  2. 2 Step

    Get the embed code and License key

    The Dashboard gives you the code for your page and a License key that identifies your shop.

    The License key and the production code are issued when Comnoira activates your shop. Until then, use a Preview.

  3. 3 Step

    Send your product information

    Send images, drawings or a catalogue of your cabin models. The Liftmira team builds the interactive 3D model for your website.

What runs where

Three parties take part in every page load. Your website holds the SDK and the container for the viewer. Your server is the only place that holds your License key. Comnoira holds the Showcase, the encrypted 3D model files and the checks that decide who may see them.

How the pieces connect
How the pieces connectFive parts: your web page, your server, the Comnoira API, the viewer and model storage, joined by six numbered exchanges.YOUR SIDECOMNOIRA123456Your web pageComnoira SDK andthe viewer containerYour serverHolds the License keyComnoira APIapi.comnoira.comViewerviewer.comnoira.com,in an iframe on your pageModel storageEncrypted model files
  1. The page asks a route on your server for a code.
  2. Your server sends the License key to Comnoira and gets back a code that lives 60 seconds and works once.
  3. The browser sends the code to Comnoira. Comnoira checks the Origin and returns a session token.
  4. The SDK opens the viewer in an iframe on your page and passes it the session token.
  5. The viewer loads the Showcase and asks for a session key for each model file.
  6. The viewer downloads the encrypted model file and decrypts it in the browser.

If your site runs on WordPress or Shopify, the plugin or the app plays the part of your server. See Three ways to integrate.

What you need for the embed code path

  • Your License key, kept on your server only. Never put it in page code, in a theme file or in a repository.
  • The publicKey and the Showcase ID of your Showcase, both shown in the Dashboard. The publicKey (it starts with pk_live_) is safe to place in a web page.
  • One route on your server that asks Comnoira for a code. Exchanging a session token shows it request by request.
  • Your website's domain, added to the Showcase's allowed domains in the Dashboard.
  • One <script> tag for the SDK and one empty element with an id where the viewer appears.

Try a Showcase before activation

There are two ways to see a Showcase in action. They suit different people.

A Preview is for a shop that is not active yet. In the Dashboard you paste a code on a page of your own website and verify that page. The Preview then shows the default demo of your industry on that page. Per the Comnoira platform rules, it ends after 14 days or 300 sessions, and it works only on the website you verified. Comnoira can switch Previews off: while they are off, the viewer says the preview is temporarily unavailable. When you ask for production and an administrator approves your shop, the Preview becomes your production Showcase. The Preview code then stops being the right code, so you replace it with the production code (see Going live checklist).

Demo mode, Comnoira.init(null, showcaseId, { demo: true }), is for Comnoira's own pages. The Backend answers demo sessions only for origins on a list Comnoira maintains, so a demo on your own domain is refused with ORIGIN_NOT_ALLOWED. To look at a demo without any setup, open liftmira.com/en/demo.

When your own model replaces the sample

A Showcase created in the Dashboard starts with the sample content of your industry. While it does, the viewer shows a small "Sample content" label. When the Liftmira team adds your model to the same Showcase, the Showcase ID, the publicKey and the code on your page stay as they are. The content comes from the Showcase when the viewer loads, so nothing on your website changes.

This holds inside one Showcase. The Preview code and the production code are different codes: the Preview uses a preview key, the production code uses your License key through your server.

Next

Three ways to integrate compares the embed code, the WordPress plugin and the Shopify app. Exchanging a session token explains the exchange behind every page load.