Translations

In this section, you will learn how to manage the translations.

Translations

The Translations section allows the defining of many language versions used throughout the Open Loyalty platform. All content elements will appear in the selected default language.

Most of the text that appears to be hard-coded on pages throughout your loyalty platform can be instantly changed to a different language by changing the default language parameter. The Default language is selected during the translation creation process but can be changed at any time in edition mode.

Moreover, during Campaigns and Tier creation/edition processes, an Admin can fulfill the Basic Information section in every language version listed here. For example, if we have Polish and English translations, there is a possibility to provide Basic information on Tiers and Campaigns in both languages.

Thanks to this, changing the default language translates the text word-for-word and references a different translation table that provides the interface text that is used in the Admin and Client cockpit. The text that can be changed includes navigational titles, labels, buttons, and links such as “List of customers” and “Account”, Campaigns and Tier names, descriptions, etc.

Currently, Open Loyalty is available in English.

To open the Translations list, go to Settings -> Translations. All available languages are listed in the table. You can change the number of rows displayed per page by clicking on the arrow icon below the table and picking a handy number from the list.

RTL (right-to-left) is supported for Arabic and Hebrew language.

---

Adding translations

To add a new translation:

1. Go to Settings -> Translations

2. Click on the 'Add Language' button. From these units, please complete such information as:

   • Code - Language identifier

   • Name - Language name

   • Order

If you would like to set such language as a default right away, please mark the 'Default' check box. But this may be marked only when the translation is already prepared and added.

To dismiss the 'Add language' screen, click on the 'X' button next to the header.

1. Click SAVE

To add a new language via the API, use this endpoint:

Method allows to create a new language entry.

This method allows creating a new Language.

POSThttp://openloyalty.localhost/api/language

Body

application/json

name*string

code*string

apiDefault*boolean

adminDefault*boolean

order*integer

Response

200400401403

Returned when successful

Body

application/json

namestring

codestring

apiDefaultboolean

adminDefaultboolean

orderinteger

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/language', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "code": "text",
      "apiDefault": false,
      "adminDefault": false,
      "order": 0
    }),
});
const data = await response.json();

Response

200400401403

{
  "name": "text",
  "code": "text",
  "apiDefault": false,
  "adminDefault": false,
  "order": 0
}

---

Managing translations

Editing language

To edit the selected language, click on the overflow button and pick from the expanded list Edit language option, here you can edit such values as Name and Order, as well as change the default language by marking the checkbox.

To set the selected language as the default one you need to find yourself on the 'Translations list' view, here click on the overflow button, next to the picked language, and choose the 'Edit language' option. In the Edit language 'name' screen mark Admin default and API default checkboxes and click 'Save'. You will return to the 'Translations list' view where the 'Language updated' toast message will appear, and information on which language is defaulted and when it was updated will be updated in the table.

---

Editing translation

To edit/add a translation, click on the overflow button and pick from the expanded list Edit translation option. On the 'Edit translation name' screen, you can add the translation for any value in the app. In the middle column, you need to add translation and on the left, you have the default language value present. Click on the record you would like to add (right in the middle) and add a new value. To dismiss this screen, click on the 'X' button and the value will be saved - so if you reopen the Edit translation, the screen will be presented.

To save all the currently active key names, you can retrieve them and save them via this endpoint:

Method will return translations.

This method returns all Translations.

GEThttp://openloyalty.localhost/api/translation

Query parameters

Response

200

Body

application/json

Other propertiesstring

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/translation', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Afterwards, you can translate all the entries and upload them via this endpoint (one key at a time):

Method will return one translation key and its value in all languages supported.

This method returns one Translation key and its value in all Languages supported.

GEThttp://openloyalty.localhost/api/translation/key/{key}

Path parameters

key*string

Response

200401403404

Body

application/json

keystring

valuestring

updatedAtstring (date-time)

languageCodestring

Request

JavaScriptCurlPython

const response = await fetch('http://openloyalty.localhost/api/translation/key/{key}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401403404

[
  {
    "key": "text",
    "value": "text",
    "updatedAt": "2024-12-21T12:21:43.681Z",
    "languageCode": "text"
  }
]

---

Removing language

To remove the language, click on the overflow button and pick the Remove option from the list. 'Do you want to remove this translation?' pop-up window will show up, confirm your action by clicking on the YES button. The Toast message will appear and the selected translation will be removed from the list.