Skip to main content

Mimeeq Embed Web API

Introduction​

The Mimeeq Web API is a powerful programming interface that gives you complete control over the Mimeeq Configurator experience. It unlocks the ability to create custom integrations, build advanced visualization workflows, and seamlessly connect the configurator with your existing business systems.

When you integrate the Mimeeq Embed on your website, you automatically gain access to these comprehensive APIs through the global mimeeqApp and mimeeqAuth objects. These interfaces enable both technical and business teams to:

  • Create custom user journeys around product configuration
  • Build tailored e-commerce integrations
  • Implement business-specific configuration rules
  • Access real-time product and pricing data
  • Develop specialized visualization experiences

API Modules​

The Mimeeq Web API is organized into two main modules, each serving a distinct business purpose:

Mimeeq Auth (window.mimeeqAuth)​

The mimeeqAuth module handles all aspects of user authentication and account management. It enables personalized experiences by identifying users and managing their permissions.

Business Value:

  • Provides secure customer authentication with minimal development effort
  • Enables personalized pricing based on customer accounts
  • Supports saved configurations specific to each user
  • Manages access to restricted product catalogs or features

This module allows you to:

  • Sign users in and out of their Mimeeq accounts
  • Verify user identity and retrieve user profile information
  • Display pre-built authentication interfaces including:

For comprehensive documentation on authentication capabilities, see the mimeeqAuth API reference.

Mimeeq App (window.mimeeqApp)​

The mimeeqApp module is the core interface for controlling the product configurator and accessing its data. This powerful API gives you granular control over the entire configuration experience.

Business Value:

  • Enables custom UI/UX around the configurator to match your brand experience
  • Provides access to real-time pricing and configuration data
  • Allows programmatic control over configuration options
  • Supports advanced visualization features like screenshots and exports
  • Enables seamless integration with e-commerce platforms

With the mimeeqApp API, you can:

  • Control the 3D visualization (camera angles, zoom, visibility)
  • Manipulate product configurations programmatically
  • Access real-time pricing information for configured products
  • Generate high-quality product images or 3D exports
  • Retrieve and modify the state of modular product scenes
  • Subscribe to data streams through observables to create reactive interfaces

For detailed product configuration APIs, see the mimeeqApp API reference.

Data Observables​

One of the most powerful features of the Mimeeq Web API is its comprehensive system of data observables. These provide real-time access to the complete state of the configurator, enabling truly responsive custom interfaces.

Observables follow the reactive programming model, where you can subscribe to data streams and be notified whenever values change. This is particularly valuable for:

  • Building custom configuration interfaces that stay in sync with the 3D model
  • Creating real-time pricing displays that update as options change
  • Developing validation systems that verify configuration completeness
  • Implementing specialized business rules based on configuration state

The observable system covers all aspects of the product configuration, including:

  • Product metadata and information
  • Available and selected options
  • Price and quantity information
  • Scene and camera state
  • Historical configuration changes

To explore the complete set of available observables, see the Observers API reference.

API Configuration​

The Mimeeq Web API includes a configuration system that allows you to customize various aspects of its behavior. This enables you to tailor the API functionality to your specific business requirements.

The mimeeqApp.config object allows you to modify aspects such as:

  • PDF generation styling and content
  • Image processing and export behavior
  • Custom icon replacements
  • Event handling preferences

Configuration timing: While most settings can be modified at any time, certain core configuration options must be set before the embed is loaded into the browser. For critical settings, we recommend initializing them using the window.mimeeqAppConfig global object before Mimeeq scripts are loaded.

// Example of setting configuration before embed loads
window.mimeeqAppConfig = {
  pdf: {
    logoPosition: 'LEFT',
    displayLogoAt: 'FIRST_PAGE',
    logo: 'https://example.com/your-logo.png',
  },
};

For detailed configuration options and examples, see:

Getting Support​

If you have questions about implementing the Mimeeq Web API or need help with specific integration challenges, our support team is available to assist you:

Our team of integration specialists can help you leverage the full power of the Mimeeq Web API to create exceptional product configuration experiences.

Other​

Types​