Interface: EmbedPayloadPartial

Core configuration for Mimeeq embed instances.

This interface defines the essential configuration parameters required for initializing a Mimeeq configurator embed. It contains identifiers, API endpoints, localization settings, and callback handlers that form the foundation for any embed instance.

The partial payload is extended by more specific embed types to add functionality unique to each embed variant.

Extended by

• MountConfiguratorPayload
• MountARPagePayload
• MountForgotPasswordPayload
• MountLoginPayload
• MountUserProfilePayload

Properties

baseURL?

optional baseURL: string

Base URL for API requests.

This specifies the endpoint for all API communications from the embed. If not provided, the system will use the default API URL from the embed environment.

---

CDNPath?

optional CDNPath: string

Path to the CDN for static assets.

This URL is used to load images, 3D models, and other static resources required by the configurator. If not provided, the system will use the default CDN path from the embed environment.

---

customerId

customerId: string

Identifier for the customer account.

This specifies which customer's products and configurations will be available in the embed. Each customer has their own isolated data and settings.

---

elementId?

optional elementId: string

Deprecated

Use uid with data-mimeeq-short-code attributes instead ID of HTML element in which to mount the embed

---

locale

locale: string

Language code for the embed UI.

This sets the language used throughout the interface, including labels, button text, and error messages. Uses standard language codes like 'en', 'fr', 'de'.

---

onEventDispatch?

optional onEventDispatch: EventDispatchCallback<any>

Callback function for handling events from the embed.

This function is called whenever a significant event occurs within the configurator, such as option selection, configuration changes, or user actions. It allows the hosting application to respond to these events.

---

uid

uid: string

Unique identifier for this embed instance.

This ID is used to identify a specific embed configuration and is typically the shortcode for the embed. The system will mount the embed into an HTML element with a data-mimeeq-shortcode attribute matching this value.

Each embed on a page should have a unique UID to prevent conflicts.

---

withWatcher?

optional withWatcher: boolean

Enables sandbox logic for development and testing.

When true, the embed runs in a sandboxed mode with additional monitoring and development features. This should generally be false in production.