Skip to main content

Embed translations API (public embed)

This page is for teams integrating or debugging the public configurator embed: how UI copy is resolved at runtime and what the CDN read model looks like. For back-office translation set authoring and assignment (templates, locales), use the Mimeeq admin UI—see Custom Language and Localization.

If you assign a translation set on an embed template, the embed loads that set from our CDN read layer. Host-level overrides are described in Custom Language.

Runtime merge order (standard embed)​

On the standard configurator embed, strings are merged in this order (later steps override earlier keys only where a value is present):

  1. Bundled locale — default English strings ship inside the embed bundle. They come from our internal package @mimeeqsoftware/translations (scoped as @mimeeqsoftware/translations/embed in app code). That package is not published for general use on public npm; access is limited to Mimeeq builds and to customer workspaces that consume our private Git/npm registry. If your repo depends on Mimeeq packages, configure the registry and auth your package manager exactly as in your Mimeeq onboarding (for example GitHub Packages or the internal registry your project uses). You do not install this package when you only drop our hosted embed script on a page.
  2. CDN read model — published JSON for the active customer, locale, and translation set stem (from the template’s embedTranslationSetIdentifier, with a documented fallback stem when none is set). Path shape:
    read_models/embed_translations/{customerId}/{languageCode}/{stem}.json
    Same path is used whether the template points at a named set or the account default (implementation picks the stem accordingly).
  3. Host override — window.mimeeqCustomMessages, then refresh via mimeeq-refresh-translations if you change it after load (see Custom Language).

For this merge, the CDN file is the runtime source for tenant copy.

Configuring copy in Mimeeq (brief)​

Translation sets and which set applies to an embed are configured in Mimeeq admin (per template and, where your account uses them, global defaults for embed). This documentation does not walk through admin screens; for step-by-step UI instructions use something like Mimeeq Help Center — for example search or browse articles about embed templates and translation (other docs link patterns such as Guide to Setting Up Pricing).