Site Management

Site Configuration

In this section, we will explain about the configuration for the site. Starting from internationalization (I18N), handling message formats and displaying lobby.

Subsections of Site Management

Lobby API

This method returns a list of games to display in the lobby. The list of games might vary depending on whether or not the player is logged in (x-auth-token). The list might also vary by the type of platform and marketing segment. use gateway.[msdomain]. If user is logged in, games will be filtered out by the user’s country, both current logged in country and registration country.

Request (GET)

/gateway/site-management/{version}/lobby/{brand_id}

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.
x-auth-token header string false player logged in session.

Response

Status 200

{
  "structure": [
    {
      "name": "mobile.gameCategory.featuredGames",
      "category_id": "featured-games",
      "games": [
        "80879",
        "80836"
      ]
    },
    {
      "name": "mobile.gameCategory.slots",
      "category_id": "slots",
      "games": [
        "70147",
        "70071",
        "181053",
        "70007",
        "1193"
      ]
    },
    {
      "name": "mobile.gameCategory.tableGames",
      "category_id": "table-games",
      "games": [
        "181025",
        "181055",
        "120008"
      ]
    },
    {
      "name": "mobile.gameCategory.scratchCards",
      "category_id": "scratch-card",
      "games": [
        "70140",
        "70132",
        "70130"
      ]
    },
    {
      "name": "mobile.gameCategory.other",
      "category_id": "virtualgames",
      "games": [
        "181011",
        "182013"
      ]
    },
    {
      "name": "mobile.gameCategory.hiddenTab",
      "category_id": "hiddenTab",
      "games": [
        "181011",
        "182013"
      ]
    }
  ],
  "games": [
    {
      "id": "181025",
      "spec": {
        "provider_name": "Groove",
        "sub_provider_name": "Groove_QMG",
        "name": "European Roulette",
        "image_url": "[PROMO_URL]/lobby_images/nyx/1x2-gaming/european-roulette.png",
        "fun_real": "BOTH"
      }
    },
    {
      "id": "70132",
      "spec": {
        "provider_name": "Groove",
        "sub_provider_name": "Groove_QMG",
        "name": "Pixie Gold",
        "image_url": "[PROMO_URL]/lobby_images/nyx/lightningbox/pixie-gold.png",
        "fun_real": "BOTH"
      }
    }
  ]
}

Status 500

{
  "errMsg": "internal_error"
}

Response Parameters:

Name Type Description
structure.name string game category tag.
structure.category_id string game category name.
structure.games array list of game ids under the category.
games.id string game id unique identifier.
games.spec.name string game name.
games.spec.image_url string game logo.
games.spec.fun_real string indication if game supports fun play mode, options are: ‘REAL’/ ‘BOTH’.
games.spec.provider_name string the provider which game comes from.
games.spec.sub_provider_name string actual vendor game is be launched from.

internationalization (i18n)

This method retrieves the i18n tags that are used for application localization and internationalization.

Request (GET)

/gateway/i18n/{version}/tags/{brand_id}/{language}

Parameters:

Name In Type Required Description
version path string true The API version to use.
language path string true The language tags should be fetched in.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200

{
  "bo.currency.CAD": "CAD - Kanadisches Pfund",
  "bo.currency.AUD": "AUD - Australischer Dollar",
  "bo.currency.EUR": "EUR - Euro"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "errMsg": "internal server error"
}

Response Parameters:

Response will contain json object with all the available tags in the system for the given language.

TnC And Privacy Policy

This method retrieves the text of your Terms and Conditions (T&C) and Privacy policy in the language that you specify. You use this method to populate your T&C page with your T&C content when a user visits it. use gateway.[msdomain]

Request (GET)

/gateway/tnc/{version}/document/revision/lastPublished/{brand_id}/{language}/{type}

Parameters:

Name In Type Required Description
version path string true The API version to use.
language path string true The language get data for.
type path string true The type of request (tnc/privacy are the only options).
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200

{
  "language": "en",
  "prompt": "1",
  "version": "26.1.1",
  "body": "this is the tnc version of brand please read all sections carefully"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
language language of given doc.
prompt an indication if player will get notified if new version of doc is available.
version current version of doc.
body doc content.

Countries

This method retrieves a list of countries that includes the country name, telephone code, and short country name in ISO3166-1 alpha2 and ISO3166-1 alpha3 formats. use gateway.[msdomain]

Please note, there is different response between versions, old version is deprecated and will be removed soon.

Request (GET)

/gateway/site-management/{version}/{brand_id}/countries

Parameters:

Name In Type Required Description
version path string true The API version to use.
brand_id path int true The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200 (if version below 1.29.15)

    [
  {
    "name": "Israel",
    "alfa2": "IL",
    "alfa3": "ISR",
    "phoneCode": "972"
  }
]

Status 200 (version 1.29.15 and above)

    {
  "country_list": [
    {
      "name": "Israel",
      "alfa2": "IL",
      "alfa3": "ISR",
      "phoneCode": "972"
    }
  ],
  "current_country": "IL"
}

Status 400

{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "result": "internal server error"
}

Response Parameters:

Name Description
current_country ISO2 country code, will be taken from X-Forwarded-For header.
country_list.name Country full name.
country_list.alfa2 Country ISO2 representation.
country_list.alfa3 Country ISO3 representation.
country_list.phoneCode Country phone prefix.

Message Format

This method returns a lightbox format pop-up structure that you can use to format a message for the player.

If a server returns an error or informative message in addition to a standard HTTP code, it is represented as a formalized string tag. The client application can then use this method to format this string tag as a user-friendly message.

The available message formats that you can use with this method are returned in the responses to several other calls, including the following ones:

Create New Withdrawal Cancel Pending Withdrawal Check Withdrawal Requirements use gateway.[msdomain]

Request (GET)

/gateway/site-management/{version}/content/message/format/{message_string}

Parameters:

Name In Type Required Description
version path string true The API version to use.
message_string path string true The message format that you want to use.
brand_id query int false The ID of the casino. If a brand_id is not provided, all message formats will be fetched from default storage.

Response

Status 200

{
  "type": "Alert",
  "title": "mobile.page.registration.headerStep1",
  "content": "mobile.page.registration.fields.login.validators.userExists",
  "button_1_text": "mobile.button.ok"
}

Status 400

{
  "errMsg": "Message Not Found according to your search"
}
{
  "errMsg": "invalid input - invalid brand id"
}

Status 500

{
  "errMsg": "internal server error"
}

Response Parameters:

Name Type Description
type string The type of the message.
title string The title to display for the message.
content string The content to display for the message.
button_X_text string where X will be incrementing number of buttons.