mimeeqApp

The Mimeeq Application API provides comprehensive control over the Mimeeq product configuration experience.

The mimeeqApp object is the primary interface for interacting with Mimeeq's powerful product configuration platform. It provides a complete suite of methods and properties for creating interactive product configurations, handling user authentication, and enabling rich visualization capabilities.

Core Capabilities

• Product Configuration: Manipulate 3D scenes, change product options, update materials, and modify configurations
• Data Access: Subscribe to observers for real-time updates on product data, option selections, pricing, and scene state
• Visual Controls: Take screenshots, adjust camera positions, modify lighting, and control scene elements
• Pricing & Commerce: Access pricing data, configure quantity pricing, and integrate with shopping cart functionality
• Authentication: Manage user authentication and account functionality (shared with mimeeqAuth)
• Mounting & UI: Mount different UI components like configurators, product lists, and AR viewers

The API architecture consists of several interconnected subsystems, each responsible for specific aspects of the configuration experience. These include observers for tracking state, actions for performing operations, and utilities for common tasks.

Usage Example

// Initialize configuration
window.mimeeqApp.initialize({
  userPoolId: 'us-east-1_xxxxxxxx',
  identityPoolId: 'us-east-1:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'
}, null, null);

// Mount a product configurator
window.mimeeqApp.mount({
  CDNPath: 'https://cdn.example.com',
  baseURL: 'https://api.example.com',
  customerId: 'customer123',
  node: document.getElementById('configurator-container'),
  uid: 'configurator'
}).then(mountRoot => {
  // Render a 3D configurator with a specific product
  mountRoot.render({
    embedType: 'CONFIGURATOR',
    variantCode: 'PRODUCT-ABC-123'
  });
});

// Subscribe to price changes
window.mimeeqApp.observers.pricing.prices.subscribe(priceData => {
  console.log('New price:', priceData.price, priceData.currency);
});

// Take a screenshot of the current configuration
window.mimeeqApp.utils.takeScreenshot('png', 1024)
  .then(imageBase64 => {
    const img = document.createElement('img');
    img.src = imageBase64;
    document.body.appendChild(img);
  });

warning

The mimeeqApp API can only be used within the context of a loaded product configurator. Many methods and observers will not function correctly outside this context.

For legacy compatibility, this object also includes some authentication functionality from mimeeqAuth, though direct use of mimeeqAuth is recommended for authentication-specific operations.

You can access all features of this API through the global window.mimeeqApp object once the Mimeeq Embed script has been loaded on your page.

Variables

mimeeqApp

const mimeeqApp: MimeeqApp