Getting Started

This documentation is intended for developers who want to understand how to integrate Mimeeq's software into a third party site. If you would like to find information about using the application, adding products, prices, 3d models and general how to your application interface, please visit our app knowledge base.

If you are not sure what you are looking for or need further assistance, reach out to us using live chat.

What is Mimeeq Configurator

Mimeeq Configurator is a client-side JavaScript embeddable web-experiences for Mimeeq application. It offers a growing library of components and methods addressing most of the requirements for customer needs and eCommerce experiences.

Learn more about Mimeeq App on our homepage.

Embed

Mimeeq provides highly customizable embeddable configurator for all customers and products. It comes in multiple variants, like

standalone product (standard and modular) configurator
product list with configurator and favourites (optional)
product group list with configurator
favourites list with configurator

You can generate any of these from snippet generator at Mimeeq App. It also allows to configure basic UI options like visibility of UI elements, language or some colors.

For further customization options please consult specific articles

Set custom translations, click here
To learn more about settings custom styles, click here
To learn about configurator customization, click here
To learn more about available configurator options, click here

Auth

Aside from configurator itself we also provide authentication functionality. You can either use mimeeq provided modals to display sign-in form or user profile or use exposed API to create you own experience.

Auth logic comes with following modal forms

To explore more about it, click here.

Components

To make it easy to add embeds on your page we provide components which you can easily put in your HTML.

Mimeeq Embed comes with following components:

mmq-embed - main component. It is used to render all embeds related to product like Product List, Favourites List or Single Configurator.
mmq-auth - authentication related component. By adding it to your DOM it will load authentication related logic and allow for displaying authorization forms.

To learn more about components, click here.

JS API

window.mimeeqApp, window.mimeeqAuth

Together with loading Mimeeq Configurator on the page, it will also include configurator JS API.

This API includes a set of useful helpers methods addressing common requirements on web and eCommerce projects.

The API is available on the window object of the website as window.mimeeqApp for configurator and window.mimeeqAuth for authentication embed.

You can explore all the available methods for configurator here and for auth here.

Data observables

window.mimeeqApp.observers

As part of above JS API we also offer data observables. These observables create possibility to subscribe to all data loaded used by configurator for currently displayed product.

It can be then used to create own configurator UI extensions or whole custom UI with only canvas coming from embed.

To learn more about observables concept, click here.

To explore available observables, click here

Events

Embed provides number of custom events triggered during configurator lifecycle. These can be used to creating more immersive experiences for you users or to get notice about some important user actions to create eCommerce integration.

Configurator not only triggers events. We also listen for some of them. You can trigger these events to manipulate some UI.

To learn more about events, click here

REST API

In eCommerce world having only client API isn't always the right answer. Especially when one consider security. To solve this issue Mimeeq provides REST API. You can use this to get product data or fetch prices for your products.

All of exposed methods require authentication. To authenticate you need to generate API Key for your company from Mimeeq App.

To dive deeper into these APIs, click here

Browser support

The following table lists the versions that Mimeeq Embed is tested on. "Latest" means that it works just fine on recent versions of that browser. Since many browsers release new versions quite often it's a little tricky to pin down specific browser version.

Since Configurator is heavily using fairly new JavaScript features like WebGL it comes with no support for old (or dead) browsers like Internet Explorer 11.

Long story short, Mimeeq Embed will work well on pretty much any modern browser.