Change API Portal language

This section describes how to change the API Portal UI texts from the default English to another language.

Install a language

User interface strings are stored in language-specific resource files. To add these resource files for a new language, you must install the language.

  1. Log in to Joomla! Admin Interface (JAI).
  2. In the JAI top navigation bar, click Extensions > Language(s).
  3. Install language
  4. Click Install Languages.
  5. Find and select the language to install, and click Install.
  1. After the installation is finished, click Extensions > Language(s) > Installed and ensure that Site is selected at the top of the page.
  2. To set the installed language as the default language of your API Portal, click the star button in the row for that language.
  3. Tip   You can change the default language of JAI independently from your API Portal. Select Administrator on the Languages: Installed page and click the star button in the row for the required language. You can also select any of the installed languages when you log in to JAI.

Add API Portal UI strings to the installed language

API Portal UI strings are not included in the installed language resource files, so you must add the required strings for the new language.

The UI strings are stored in initialization (.ini) files. Each language has its own .ini file that control the UI text shown in API Portal. By default, the API Portal UI strings are included only in the English .ini file (en-GB.com_apiportal.ini). To change the language shown in API Portal, you must have a translation of the English .ini file for that language.

Because the .ini files are text files, you can use professional translation services to get the file translated. Alternatively, you can manually translate the UI strings yourself.

Add a translated UI string file

You can send the file en-GB.com_apiportal.ini file for translation to a professional translation service, and include the translated file in your API Portal installation.

To find the en-GB.com_apiportal.ini file that must be translated, go to the following directory in your API Portal installation:

/opt/axway/apiportal/htdoc/language/en-GB/

Before you send the file for translation, it is recommended to rename the file to en-GB.com_apiportal.ini.txt. When you receive the translated file, you should remove any .txt extension again before proceeding with the following steps.

To install the translated file:

  1. Go to the resource file directory of the language you installed (for example, /opt/axway/apiportal/htdoc/language/fr-FR/).
  2. Copy the translated .ini file to the directory.
  3. Ensure that the language code in the file name of the translated .ini file matches the language code of the installed language, and the extension of the file is .ini (for example, fr-FR.com_apiportal.ini). Rename the file, if needed.
  4. Go to your API Portal, refresh the page, and verify that the UI texts have changed to your new language.

Manually translate the UI strings

  1. Copy the following file from the English resource file directory:
  2. /opt/axway/apiportal/htdoc/language/en-GB/en-GB.com_apiportal.ini
  3. Go to resource file directory of the language you installed (for example, /opt/axway/apiportal/htdoc/language/fr-FR/), and paste the copied file there.
  4. Rename the copied .ini file to match the language code of the installed language (for example, fr-FR.com_apiportal.ini).
  5. Open both the English .ini file and the copied .ini file.
  6. In the English .ini file, find a UI text you want to change (such as the text Connect with a community of developers at the bottom of the API Portal sign in page), and copy the UI string ID (COM_APIPORTAL_HOME_CONNECT).
  7. In the copied .ini file, find the same UI string, and change the value of the string to the new language translation.
  8. Repeat the last two steps for all the UI strings on all your API Portal pages that you want to change to the new language, and save the file.
  9. Go to your API Portal, refresh the page, and verify that the UI texts have changed to your new language.

Change the text overrides on the Sign In page

Some texts on the Sign In page are controlled by text overrides, and you have to change them separately in the .override file.

  1. Go to the language override directory /opt/axway/apiportal/htdoc/language/overrides/.
  2. Copy the file en-GB.override.
  3. Paste the file in the same directory, and rename it to match your new language (for example, fr-FR.override).
  4. Open the renamed file, find the UI string with the value Login Name, and change the value of the string to the new language translation (for example, Identifiant).
  5. Find the UI string with the value Password, and change the value of the string to translate it (for example, Mot de passe).
  6. Save the file, and go to your API Portal.
  7. Go to the API Portal Sign In page, refresh the page, and verify that the UI texts have changed to your new language.

Related Links