About the Locale Management APIs

The Wix Multilingual Locale Management APIs allow you to set up and manage the language structure of multilingual websites. These APIs enable you to define which languages and regions you want your site to support, and configure the settings that control how different language versions are structured and accessed. Learn more about the Wix Multilingual feature.

Wix Multilingual Locale Management APIs include two services:

• Locale Settings
• Locales

The Locale Settings API handles site-wide multilingual configuration, while the Locales API manages individual locales for the secondary languages and regions.

How the APIs work together

• You must enable multilingual mode using the Locale Settings API before you can create secondary locales with the Locales API.
• The Locale Settings API defines the default URL structures for all secondary languages. You can then override these defaults for individual locales using the Locales API.
• The Locale Settings API manages site-wide behaviors like auto-switching based on browser language. The Locales API controls language-specific settings like which languages are visible to visitors.
• The Locale Settings object contains primary locale information. However, to change the site's primary locale, use the Locales API.

Terminology

• Locale: A combination of language and optional region code that defines how content should be displayed for a specific audience.
• Primary locale: The locale in which the site is created, serving as the default language and regional settings.
• Secondary locale: Additional locales used to display translated content based on visitor preferences.
• Visitor primary locale: The default language shown to site visitors when they first visit the site.
• Multilingual mode: A setting that enables a site to support multiple locales. Requires the Wix Multilingual app to be installed.
• Locale settings: Configuration object that holds the site's multilingual behavior settings.
• Auto switch: Automatic redirection to a secondary locale based on visitor's browser language settings.
• Visibility: Whether a locale is visible to site visitors or hidden for translation purposes.

Related APIs

Once you've set up your locales and their settings, you can move on to managing content translations using the Translation APIs. You can also use the Machine Translation APIs to automatically generate translations and streamline your workflow.