Localization

Responses are localized server-side based on the following rules listed by order of priority:

1. User Profile
2. IP Address
3. Platform Settings

Context

The I18NContext containing the perceived client's information that will be used to localize responses is provided by platform.i18n.

query I18NContext {
  platform {
    i18n {
      country {
        isoCode
      }
      language {
        isoCode
      }
      currency {
        isoCode
      }
    }
  }
}

{
  "data": {
    "platform": {
      "i18n": {
        "country": {
          "isoCode": "FR"
        },
        "language": {
          "isoCode": "FR"
        },
        "currency": {
          "isoCode": "EUR"
        }
      }
    }
  }
}

If needed, you can also get the client geolocation (which is not influenced by the user profile settings) from platform.access.country:

query ClientGeolocation {
  platform {
    access {
      country
    }
  }
}

{
  "data": {
    "platform": {
      "access": {
        "country": "FR"
      }
    }
  }
}

Content Filtering

Most cms models (Category, Product, ...) can have their visibility or possible actions (such as purchase) restricted based on the user's country location (platform.access.country). This is configurable from the back office model's editor and is automatically applied by filtering API responses.

Text

I18NString are texts localized in responses, regular String are not.

query GetCategories {
  cms {
    categories {
      items {
        id
        name
      }
    }
  }
}

{
  "data": {
    "cms": {
      "categories": {
        "items": [
          {
            "id": "2",
            "name": "Home"
          },
          // ...
        ]
      }
    }
  }
}

{
  "data": {
    "cms": {
      "categories": {
        "items": [
          {
            "id": "2",
            "name": "Accueil"
          },
          // ...
        ]
      }
    }
  }
}

Price

Prices are converted from the default platform currency to the user country currency and we also provide formatted price strings that you can display.

query Products {
  cms {
    products (includeIds: [1]) {
      items {
        id
        name
        extension {
          ... on ProductTVOD {
            accessModes {
              id
              type
              price
              priceFormat
            }
          }
        }
      }
    }
  }
}

{
  "data": {
    "cms": {
      "products": {
        "items": [
          {
            "id": "1",
            "name": "The line",
            "extension": {
              "accessModes": [
                {
                  "id": "64",
                  "type": "SUBSCRIPTION",
                  "price": null,
                  "priceFormat": null
                },
                {
                  "id": "2",
                  "type": "RENT",
                  "price": 3.5,
                  "priceFormat": "€3.50"
                },
                {
                  "id": "3",
                  "type": "RENT",
                  "price": 4.333333,
                  "priceFormat": "€4.33"
                },
                {
                  "id": "1",
                  "type": "RENT",
                  "price": 6,
                  "priceFormat": "€6.00"
                }
              ]
            }
          }
        ]
      }
    }
  }
}

{
  "data": {
    "cms": {
      "products": {
        "items": [
          {
            "id": "1",
            "name": "The line",
            "extension": {
              "accessModes": [
                {
                  "id": "64",
                  "type": "SUBSCRIPTION",
                  "price": null,
                  "priceFormat": null
                },
                {
                  "id": "2",
                  "type": "RENT",
                  "price": 3.8337774999999996,
                  "priceFormat": "$3.83"
                },
                {
                  "id": "3",
                  "type": "RENT",
                  "price": 4.746581301545,
                  "priceFormat": "$4.75"
                },
                {
                  "id": "1",
                  "type": "RENT",
                  "price": 6.572189999999999,
                  "priceFormat": "$6.57"
                }
              ]
            }
          }
        ]
      }
    }
  }
}