API- Translation

Written By mvishwakarma (Administrator)

Updated at October 15th, 2025

Introduction

The API Translation feature under the Loyalty → Products → Additional Loyalty Settings section allows administrators to configure multilingual support for the Loyalty system.
This feature enables translating text through APIs for supported languages, ensuring users across different regions can interact with the system in their preferred language.

It provides options to:

  • Enable or disable API-based translation.
  • Add or remove supported languages.
  • Manage language codes and track audit logs related to language configuration.

API-Translation

Navigation: Products > Additional Loyalty Settings > API-Translation

Configuration Steps

Step 1: Navigate to API Translation

  1. Go to the top navigation menu and select Products → Additional Loyalty Settings.
  2. Scroll to locate the API Translation tile and click on it.

Step 2: Enable API Translation

  • On the API Translation screen, toggle the Enabled API Translation switch to ON.
    • This activates translation support for the system.
    • Any changes are automatically logged in the Audit section for traceability.

Step 3: Add Supported Languages

  • Click on the Add New Language button on the right side of the screen.
  • The Add New Language dialog box appears.
  • From here:
  1. Select the language you want to support from the dropdown list.
  2. The system automatically fills the Custom Language Code (e.g., cs for Czech).
  3. Click Save to add the language to the list of supported languages.

Note: You can also edit the custom language code manually.

The API-Translation page includes these fields:

 
 

Field Name

Description

Enabled API Translation

Toggle button to activate or deactivate the translation API integration. When switched ON, the system begins translating configured text fields using API calls.

Audit

A clickable icon beside the toggle switch. It records all configuration activities (e.g., enabling/disabling translation, adding/removing languages).

Language

Displays the name of the supported language (e.g., English, Czech).

Language Code

ISO-standard code representing the selected language (e.g., en for English, cs for Czech).

Custom Language Code

Custom-defined language identifier. It can be used for internal mapping or integration with third-party APIs.

Status

Indicates whether the language is currently active or inactive for translation.

Action

Provides options to edit or remove a language entry.

Add New Language Button

Opens a dialog box to add a new language to the translation system.

Support Language Removed Log

Tracks and logs details of any language removal activities for audit and compliance purposes.

Text-Translation

  • The Text Translation page is part of the API Translation module used for managing multilingual content within the application.
  • It allows members to synchronize, view, upload, and publish translation text entries for different languages.
  • This ensures that all user interface texts, messages, and labels are available in multiple languages across the system.
  • The page mainly serves as a translation management interface - helping administrators and translators to keep the system text updated and consistent.

Fields and Description

Fields

Functionality

Synchronize Text (Button)

Fetches and synchronizes all available text entries from the system or API for translation.

Upload Translation (Button)

Allows members to upload translation files (e.g., .csv, .xlsx, or .json) containing translated text.

Publish (Button)

Publishes or deploys the translated texts to the live environment, making them visible in the system.

Table Columns Description

Column Name

Description

Purpose

English

Displays the default source text in English.

This is the original text that needs to be translated into other languages. Each entry here represents a UI label, message, or content string used in the application.

Action

Provides options (buttons or icons) to perform actions on each translation entry.

Common actions include Edit Translation, Delete Entry, or View Details. This column enables members to manage each translation record individually.

Working Process

Step

User Action

System Response

1

Click Synchronize Text

System fetches and displays all English text entries available for translation.

2

View entries under English column

Shows the default system text.

3

Perform action under Action column

Allows translation, editing, or deletion of entries.

4

Click Upload Translation

Uploads translated file to update multiple entries at once.

5

Click Publish

Publishes the finalized translations to the live system.

Note: The code added under the respective language in the API will translate the text description and name into that specific language within the corresponding API. The translation will occur only if the respective field’s translation exists in the Admin API’s translation section. The applied translation depends on the Language-Code provided in the API header.