Fetching translations

Translation Hosting is a content-delivery network (CDN) for your translations. It enables you to safely deliver translations anywhere in the world with superfast access speed. It's available in all pricing plans including the Community plan.

Base URL for fetching translations:

https://cdn.simplelocalize.io

If you are looking for customizing the hosting provider, see the custom hosting providers section.

Parameters

To fetch the basic translations, you need to provide only your project token and environment key in the URL. Other parameters are optional and can be used to get translations for a specific language, namespace or customerId.

• projectToken - your project token,
• languageKey - language key from the 'Languages' tab, e.g.: en, pl, de,
• environment - environment key, e.g.: _latest or _production,
• namespace - namespace, e.g.: common, home, auth,
• customerId - customerId used for customer-specific translations, e.g.: ikea,
• tag - tag name used for tag-based translations, e.g.: mobile, web.

Get all translations

Example response

{
  "de": {
    "SALE": "Verkauf",
    "ADDRESS": "Adresse"
  },
  "fr": {
    "SALE": "soldes",
    "ADDRESS": "adresse"
  }
}

Get translations by language key

Example response

{
  "SALE": "Verkauf",
  "ADDRESS": "Adresse"
}

Get languages

Example response

[
   {
      "key": "de",
      "name": "Deutsch",
      "isDefault": false,
      "icon": "de"
   },
   {
      "key": "en",
      "name": "English",
      "isDefault": false,
      "icon": "gb"
   },
   {
      "key": "es",
      "name": "Español",
      "isDefault": false,
      "icon": "es"
   }
]

See blog post about hosted country flags and learn how to use icon values to show flags in your app.

Get translations by language key and namespace

Example response

{
  "SALE": "Verkauf",
  "ADDRESS": "Adresse"
}

Tag-based translations

Tag-based translations allow you to publish separate resources for each tag. One translation key can have multiple tags, and one tag can be assigned to many keys (many-to-many relationship). If a key has multiple tags, it will appear in the resources for each of those tags. This is useful when you want to deliver only a subset of translations to a specific part of your application, e.g., mobile, web, email.

To enable tag-based publishing, go to 'Settings' > 'Hosting' and enable 'Publish translations by tags' option. After enabling it, publish translations to generate the tag resources.

Get list of tags

Example response

[
   {
      "name": "mobile"
   },
   {
      "name": "web"
   }
]

Get translations by tag and language key

Example response for /_tag/mobile/en

{
  "WELCOME": "Welcome",
  "GOODBYE": "Goodbye"
}

Get translations by tag, language key, and namespace

Example response for /_tag/mobile/en/common

{
  "WELCOME": "Welcome"
}

Tag-based translations work together with namespaces. If your project uses namespaces, you can combine tag and namespace to fetch only the translations for a specific tag within a specific namespace.

Customer-specific translations

Customer-specific translations allow you to deliver different translations to different customers using the same project. It's useful when you want to provide customized translations for your clients or partners. The structure of customer-specific translations is the same as for regular translations.

Get customers

Example response

[
   {
      "id": "ikea"
   },
   {
      "id": "adidas"
   }
]

Get multilingual translations for customerId

Get translations by language key and customerId

Error responses

At the moment, the only error response you can get is 404 when requested translation is not found, and the response body will look like this:

{
  "status": 404,
  "msg": "Hosting resource not found"
}