GetGames() API

This API request allows the operator to receive a full list of our games which are enabled for their particular front-end. If no games are enabled, the response would return as “empty”.

GetGames() Request

Type	Input
HTTP Method	POST
API URL	https://<API_BASE_URL>/games/get-games/
Headers	"Content-Type": "application/json"
POST Parameters	json object e.g.: { "api_key": "1pghjl4v5apt2bks" }

Parameters	Type	Description
api_key	String	API Key allocated to each front-end

GetGames() Response + Example

{
  "result": {
    "games": {
      "slots": [
        {
          "game-fruityfeast": {
            "game_id": 4,
            "game_name": "fruityfeast",
            "game_title": "Fruity Feast",
            "category": "slots",
            "supplier": "test_games",
            "story": "Reap the Fruity Rewards",
            "logos": [
              {
                "url": "https://test-gaming.com/images/lobby/200x150/
fruityfeast.png",
                "width": "200",
                "height": "150"
              },
              {
                "url": "https://test-gaming.com/images/lobby/400x300/
fruityfeast.png",
		"width": "400",
		"height": "300"
              }
            ],
            "launch_params": [
              {
                "width": 800,
		"height": 600,
		"resizable": true,
		"scrollbars": false,
		"type": "browser",
		"launch_type": "new_window",
		"window_title": "%full_site_code%_%category%",
		"channel": "desktop",
		"launch_url": "https://testgames.testsite.com/game_launcher.php?
session_id=%session_id%&channel=desktop&full_site_code=PFMNGOP&language=en&
game_name=%game_i d%&category=slots&amount_
type=%amount_type%&reality_check=%reality_check%"
              },
              {
		"type": "browser",
		"launch_type": "same_window",
		"channel": "mobile",
		"launch_url": "https://testgames.testsite.com/game_launcher.php?
session_id=%session_id%&channel=mobile&
full_site_ code=PFMNGOP&language=en&game_name=%game_id%&
category=slots&amount_type=%amount_type%&reality_check=%reality_check%"
              }
            ],
            "amount_types": [
              {
                "id": "cash",
		"value": 1,
		"name": "Play"
              },
              {
		"id": "bonus",
		"value": "2",
		"name": "Play"
              }
            ]
          }
        },
        {
          "game2": "game_details"
        }
      ],
      "table_games": [],
      "scratch_cards": []
    }
  }
}

Parameters	Type	Description
result	JSON Object	Key values would be displayed as a dictionary.
games	JSON Object	Presented as a key inside the dictionary.
game_type	JSON Object	Inside each game is a list containing game specific details in dictionary form.

GetGames() Error Response

Any response would be provided in JSON format. Display Type: dictionary. The dictionary contains two keys names “error” and “error_details”. If an error occurs, the error key will contain the value 1 and the error_details key would contain the information detailing that specific error. Any displayed messages would be setup as appropriate to each error.

{
	"error": 1,
	"error_detail": {
		"id": 1001,
		"code": "INVALID_API_KEY",
		"message": "Invalid API key."
	}
}