Locale: Technical Information

Introduction

There are a few things to make note of when configuring the connector with PrestaShop. Some of this information may not apply to all users, while some of it may only be important to consider at the time of the initial setup of the connector. For this reason, some of those details have been added to the Locale: Adding the Prestashop Connector to your Locale instance article.


What you will need to get started

  1. The Login link for Locale.

  2. The login link for your PrestaShop instance.

    1. Note: This is provided to you by your PrestaShop account manager, support team, or contact person. If you are unsure of this information, please contact your system administrator or your PrestaShop representative.

  3. User login information for both your Locale instance, and your PrestaShop instance

    1. A trial account of Locale can also be taken for free by going to locale.to and selecting the “Get Started” button.


Currently supported resources

As of December 2023, we currently support the localization of products and their descriptions. Additional resource options may be added at a later date. For more information on this or to leave a feature request contact XTM International Support.


Required configuration

There are 3 core pieces of information which are needed to configure the PrestaShop connector with Locale: Store domain, Store hosting and an Access key.

Store domain

The domain of the PrestaShop store is required for the basic fact that it is needed to establish the connection. However, a single instance of PrestaShop can host multiple PrestaShop stores. In this case, each store is classified per domain. It is necessary to give access to the specific domain that requires translation, otherwise this can cause an error.

Example: MyFrenchStore where myfrenchstore is the specific domain containing the text for translation.

Store hosting

This may not apply to all users. Two PrestaShop stores cannot share the same URL. However, you can connect as many stores as you want on one domain name by using a sub-folders or sub-domains structure. In the event a store is hosted within a sub-folder (in this case it is not a physical folder, but a PrestaShop store automatically created via updating a Virtual URL) it has to be included as well as part of the Store Domain URL to be used/accessed by Locale.

Example: ….MySecondStore where mysecondstore is the domain hosting location.

Access key requirements

The access key is generated in the Admin Page → Advanced Parameters → Webservice. When creating and configuring the access key from your PrestaShop instance to be used in Locale, it is important to include the 3 following components/resources:

Product Resources must be enabled as seen below (read and write).

Prestashop - Access Key Products 001.png
  • Language Resources must be enabled as seen below (read and write).

Prestashop - Access Key Languages 001.png
  • PrestaShop Webservice Activation must be enabled as seen below.

  • For more information on the access key options and granting access, you can access the PrestaShop development documentation here: PrestaShop.


Language mapping

The languages which are enabled for translation in your PrestaShop instance must contain language codes (language_code) that match the languages codes in Locale.

If for example, your Locale project contains French fr as the target language, but the French enabled in your PrestaShop instance has a fr-FR language code, this will cause an error. Both languages will need to have fr under the language_code mapping information.

Language mapping information in Locale can be found at the time of project creation, or by adding a new language to an existing project, as seen below:

Language mapping information for PrestaShop can be found under the Localization settings when adding or editing a language as seen below. Locale relies on the information in the language_code section so be sure that the language code here matches the same language code which can be found in Locale (see screenshot above as well as below).


Terminology

  • Physical URL: The physical path of your installation on your server. If you installed the store in the root directory, then the physical URL should be /. Alternatively, if you installed your store in a sub-folder, the physical URL is the name of the sub-folder.

  • Virtual URL: Thanks to URL rewriting, you can use this option if you want to create a store with a URL that doesn't exist on your server, without having to create a sub-folder. For example, if you want your store to be available with the URL www.example.com/my-store/shoes/, you have to set “shoes/” in this field, assuming that my-store/ is your physical URL. Friendly URLs must be enabled in Shop Parameters → Traffic & SEO.

    • Note that this option only works for subfolder stores, not subdomain stores.

  • Final URL: Here, you can get a preview of what the store's URL will look like, based on above settings.