Interface: EmbedEnv
Environment configuration for Mimeeq embeds.
This interface defines the global environment settings that Mimeeq embeds use to connect to APIs, access resources, and configure authentication. These settings are typically provided through the global window.mimeeqEmbedEnv object and used by all Mimeeq embeds on the page.
The environment configuration is essential for properly connecting embeds to the correct API endpoints, asset storage, and authentication services.
Properties
APIPath
APIPath:
string
Path to API gateway.
This URL is the endpoint for all API communications from the embed, including product data, configuration management, and user operations.
appSyncConfig
appSyncConfig:
AppSyncConfig
Configuration for AWS AppSync GraphQL API.
These settings enable real-time data synchronization and advanced querying capabilities for the embed.
appUrl?
optionalappUrl:string
Base URL for the application.
Used primarily for AR experiences and return paths.
appVersionHash
appVersionHash:
string
Deprecated
Use hash instead
authVersionHash
authVersionHash:
string
Deprecated
Use hash instead
CDNPath
CDNPath:
string
Path to CDN with customer assets.
This URL is used to load product images, 3D models, and other static resources required by the configurator.
cognitoConfig
cognitoConfig:
AuthOptions
Configuration for AWS Cognito authentication.
These settings enable user authentication and authorization for accessing protected resources and user-specific features.
domain
domain:
string
Domain for the current environment.
The base domain used for API and resource access.
hash
hash:
string
Version identifier for the current embed build.
This unique hash identifies the specific version of the embed code being used, allowing for version tracking and troubleshooting.
s3Config
s3Config:
object
Configuration for Amazon S3 asset storage.
These settings define how the embed accesses and stores assets like images, models, and user-uploaded content.
bucket
bucket:
string
S3 bucket name for asset storage.
sentry
sentry:
object
Error tracking and monitoring configuration.
These settings connect the embed to error reporting services to help identify and resolve issues in production.
dsn
dsn:
string
Sentry DSN (Data Source Name) for error reporting.
environment
environment:
string
Environment identifier for categorizing reported errors.