Calls to be implemented by games
General
In order to supply information about games / health and auto closing of games, engines should listen and respond to the following calls.
GET ${backendQueue}/certifiedfiles [optional, mandatory for some jurisdiction]
This call should return information about certified components with hashes. No parameters are passed.
Example of response (JSON)
{
"list": [
{
"file": "./dist/certified/certifiedLogic.js",
"hash": "e6a01ef0f88b1cac2696ce30166fca0bf6b6c793"
},
{
"file": "./dist/certified/certifiedGameSettings.js",
"hash": "1409450b798f0ac552ea1c128ff40b0f137e3f38"
}
]
}GET ${backendQueue}/getGameConfiguration [optional, mandatory for freeplay]
This call should return the game configuration and should include allowed stakes,
The following parameters are passed as URL (query) parameters.
Message.query['currency']
message.query['currencyMultiplier']
message.query['gameCode']It should return a JSON structure (example)
{
"config": {
"stakes": [
10,
20,
50,
100,
200,
500,
1000,
2000,
5000,
10000
],
"currency": "EUR",
"currencyMultiplier": 1,
"expectedRtp": 96.19,
"oneHundredXOdds": 5522,
"maxWinOdds": 103680,
"maxPayout": 1000,
"maxPayoutOdds": 2488327800,
"maxExposure": 10000000,
"calculatedMaxExposure": 10000000,
"operator": "internal_testoperator",
"winlineCount": 5
},
"gameCode": "game-bells"
}Note: Mandatory fields in the above sample are marked in red! This call can be mandatory for some operators!
Note: This call is mandatory in case freeplays are to be supported!
GET ${backendQueue}/health [mandatory]
Should return an HTTP status code of 200 and a JSON structure containing information about gamehealth (free format). This call can also be used for testing purposes.
POST ${backendQueue}/getGameResult [mandatory]
This call is used to get a HTML representation of a game result. This call will be proxied back to a request made by an operator, so it should include the information “externalPlayerId” in order to resemble the information present in operator support systems.
Request body
| attribute | comment |
| externalPlayerId | playerid on operator side |
| operatorName | friendly name of the operator |
| gameRound | Hash of gameround |
| gameRoundDetails | All information that is stored in hizi.io database |
| short | Boolean true or false, if not set or false just return a representation which can be displayed to the player (used by some operators for in-game history) |
Response (example)
The response has the following structure: a JSON object with the key 'msg' and a value containing an HTML representation of the game result.
{
msg: '<html>...</html>'
}POST ${backendQueue}/doGetGameHistory [optional]
This command can be used to display in-game history of game events. Contact hinterzimmer support for enabling and details.
POST ${backendQueue}/doAutoClose [mandatory, also for RGS-to-RGS]
This call is sent to the game engine by the hizi.io janitor task. Most operators require that open gamerounds are closed (auto-closed) after a given timespan which is normally between 12 and 48 hours. Game engines should listen to this call and execute a close / autoplay routine in case the gameround is open and can be closed.
The doAutoClose request should do the same as if a player would have re-loaded the game and continued the game round.
So the game engine has to send the normal flow, potential winnings and an end game round request.
Request body
attribute | comment |
| gameRound | Hash of gameround to be closed |
Response
Free format JSON structure, the HTTP status should reflect if the gameround has been closed (200 = success, any other meaning an error)
Notes: This call won’t have any valid token, so the game has to request a token which can be used for further API calls. Refer to getTokenForGameRound call
When receiving that call you can use any V2 calls to get information about the gameround such as collectWin.