Skip to main content

Welcome to Mimeeq Configurator

This documentation is designed for developers and business stakeholders who want to understand how to integrate Mimeeq's powerful product configuration platform into their websites and applications. If you're looking for information about using the Mimeeq application itself, adding products, managing prices, uploading 3D models, or general application usage, please visit our app knowledge base.

If you're unsure where to find specific information or need personalized assistance, please reach out to us using the live chat feature.

What Is Mimeeq Configurator?​

Mimeeq Configurator is a sophisticated, client-side JavaScript platform that delivers immersive, embeddable product visualization experiences. It allows your customers to interact with, customize, and explore your products in realistic 3D environments directly on your website.

Our configurator technology helps businesses:

  • Reduce returns by providing accurate product visualization
  • Increase conversion rates through interactive engagement
  • Streamline the custom ordering process
  • Deliver powerful visual experiences without requiring specialized development

Learn more about Mimeeq's complete business solutions on our homepage.

Embed Types and Capabilities​

Mimeeq provides highly customizable embeddable configurators to meet diverse business needs. Our platform supports multiple experience types:

  • Standard Product Configurator: For individual products with customizable options
  • Modular Product Configurator: For complex, component-based products that can be arranged in space
  • Product List with Configurator: A browsable catalog with embedded configuration capability
  • Product Group List with Configurator: Focused catalog views for specific product categories
  • Favorites List with Configurator: Personalized collections of saved configurations

You can generate any of these experiences from the snippet generator in the Mimeeq App. The generator allows you to configure essential UI options including visibility of interface elements, language settings, and brand colors.

For deeper customization and extended capabilities, explore our specialized documentation:

Authentication Capabilities​

Beyond product configuration, Mimeeq provides complete authentication functionality to support personalized experiences. You can either use our pre-built modal interfaces for user authentication or leverage our API to create fully custom experiences.

Our authentication system includes ready-to-use interfaces for:

To explore our authentication capabilities in depth, see our authentication documentation.

Web Components​

To simplify integration, Mimeeq provides web components that can be easily added to any HTML page. These components encapsulate complex functionality in simple HTML tags.

Mimeeq offers two primary components:

  • mmq-embed: The core component for rendering all product-related embeds, including configurators, product lists, and favorites collections
  • mmq-auth: The authentication component that handles user login, registration, and profile management

These components offer a clean, declarative way to integrate Mimeeq functionality without complex JavaScript implementation. For detailed information on component usage and attributes, see our components documentation.

JavaScript API​

When Mimeeq Configurator loads on your page, it provides comprehensive JavaScript APIs that give you programmatic control over the configurator experience.

These APIs are available as global objects:

  • window.mimeeqApp: Controls the product configurator
  • window.mimeeqAuth: Manages authentication features

Our JavaScript APIs enable you to:

  • Programmatically control the configurator
  • Respond to user actions and configuration changes
  • Access product and pricing data
  • Implement custom business logic
  • Create seamless integrations with your existing systems

Explore the complete API documentation for configurator functions and authentication methods.

Data Observables​

As part of our JavaScript API, Mimeeq provides powerful data observables that give you access to the real-time state of the configurator and its data.

The window.mimeeqApp.observers system allows you to:

  • Subscribe to changes in product configuration
  • Monitor price updates as options change
  • Track user interactions with the configurator
  • Access complete product and option data
  • Create custom UIs that react to configuration changes

Observables are ideal for building custom configurator interfaces or extending the standard interface with specialized functionality. They follow the RxJS Observable pattern, providing a robust foundation for reactive programming.

To understand the observable concept in depth, see the RxJS guide.

For a comprehensive list of available observables, see our observers documentation.

Events​

Mimeeq Configurator communicates through a rich event system that allows your website to respond to user actions and configuration changes. These events enable you to create seamless integrations with your business systems and deliver personalized user experiences.

Events are triggered during key moments in the configurator lifecycle, such as:

  • When a user selects a product option
  • When pricing updates based on configuration changes
  • When a user adds a configured product to their cart
  • When a configuration is saved or shared

Your website can also send events to control the configurator, creating truly bidirectional communication.

For a complete guide to the event system, see our events documentation.

REST API​

For enterprise integration scenarios where client-side communication isn't sufficient, Mimeeq provides a comprehensive REST API. This server-side interface allows you to:

  • Securely access product data
  • Retrieve accurate pricing information
  • Process orders and configurations
  • Manage user accounts and permissions
  • Integrate with ERP, CRM, and e-commerce systems

All API methods require authentication using API keys generated from the Mimeeq App. This ensures secure access to your business data.

For detailed API documentation, see our API reference.

Browser Compatibility​

Mimeeq Configurator is built on modern web technologies to deliver exceptional performance and visual quality. The following table indicates the browsers we officially support:

ChromeFirefoxEdgeOperaSafari
Latest ✔Latest ✔Latest ✔Latest ✔Latest ✔

Because the configurator leverages WebGL and modern JavaScript features, it does not support legacy browsers like Internet Explorer 11. Our focus on modern browsers ensures we can deliver the highest quality 3D visualization and optimal performance.

In practice, Mimeeq Configurator works well on any contemporary browser on both desktop and mobile devices, providing a consistent experience across platforms.