Platform API

General schemes of the Platform's responses to the Partner's requests

All responses from the Platform to the Partner's requests come in JSON format

  • Http Status Code - not part of the API and should be 200 in all responses (in case of successful and unsuccessful calls). An Http Status Code other than 200 indicates either serious problems on the server, or a completely erroneous request. Check the documentation or contact technical support.
  • General scheme of a positive response: All positive responses in the response body contain "status": 200 
    {
      "status" : 200,
      "method" : "service.method",
      "response" : ...response entity as json...
}

  • General scheme of a negative answer:

    {
      "status" : "numeric code other than 200",
      "method" : "service.method",
      "message" : "A string description of the error. For security reasons, the description 
does not necessarily clearly describe what happened on the server, but in some cases it can serve 
as a hint. In other cases, contact technical support."
}

Methods on the Platform side

/games.list - Getting a list of games

  • Method HTTP
    • GET
Platform response example

JSON:

{
    "method": "games.list",
    "status": 200,
    "response": [
      {
        "id" : 15,
        "title" : "Always Hot",
        "icon" : "button_slot_alwayshot.png",
        "type" : "slots",
        "provider" : "superomatic",
        "is_enabled" : true,
        "group" : "gaminator"
      },
      ...
    ]
}

/currencies.list - Getting a list of available currencies

  • Method HTTP
    • GET
Platform response example

JSON:

{
    "method": "currencies.list",
    "status": 200,
    "response": [
      {
        "title" : "Euro",
        "code" : "EUR",
        "minor_units" : 2
      },
      ...
    ]
}

/init.session - Getting a link to a game session

  • Method HTTP
    • POST
  • Header
    • Content-type: application/json
  • Parameters
    • @partner.alias - Partner ID (Login of Subagent)
    • @partner.session - Player session ID generated by a Partner
    • @freerounds.id - Freeround ID. Optional parameter (specify only for activating freerounds).
    • @game.id - Game ID on the Platform side
    • @currency - Game session currency
Platform response example

JSON:

{
    "method": "init.session",
    "status": 200,
    "response": {
      "casinoBrand": "some",
      "clientDist" : "https:\/\/example.com",
      "token" : "85520955afda57b28905181593440dbb",
      "targetElement": "game"
    }
}

/init.demo.session - Getting a link to a DEMO game session

  • Method HTTP
    • POST
  • Header
    • Content-type: application/json
  • Parameters
    • @balance - Demo balance
    • @denomination - Denomination of the demo balance in hundredths (with a value of 100, the denomination is 1:1)
    • @game.id - Game ID on the Platform side
    • @currency - Game session currency
Platform response example

JSON:

{
    "method": "init.demo.session",
    "status": 200,
    "response": {
      "casinoBrand": "demo",
      "clientDist" : "https:\/\/example.com",
      "token" : "85520955afda57b28905181593440dbb",
      "targetElement": "game"
    }
}

/close.session - Forced closing of the game session

  • Method HTTP
    • POST
  • Header
    • Content-type: application/json
  • Parameters
    • @partner.alias - Partner ID (Login of Subagent)
    • @partner.session - Player session ID generated by a Partner
  • Implementation features
    • During a processing of a request, the Platform sends 2 requests to a Partner /check.balance and /deposit.win. The session will be closed only if both requests are successful
    • /check.balance updates a balance on the Platform side in case it has changed on a Partner's side
    • The sum of all prizes from unfinished features of the game by the player will be sent by request /deposit.win
    • Closing a session during interactive bonuses is not recommended
    • After a session is closed, it becomes unavailable for further play. Including if there are unfinished freerounds in this session
    • The Platform works correctly, both with the option without closing sessions and with closing. With the option without closing, the game session is paused, as it were, and a player can return to it at any time. The forced closing of a session ensures that a player will not have a prize in a game that has not been credited to a balance. The choice of the way to end a game the Platform leaves to a Partner
    • The choice of how to end the game can be provided to a player by showing, for example, a modal window with choices: "Pause the game" or "End the game session"
Platform response example

JSON:

{
    "method": "close.session",
    "status": 200,
    "response": true
}

/games.freeroundsInfo - Getting a summary of the status of a freeround.

  • Method HTTP
    • POST
  • Header
    • Content-type: application/json
  • Parameters
    • @partner.alias - Partner ID (Login of Subagent)
    • @sign - Signature
    • @freerounds.id - unique identifier of freerounds for a Partner
Platform response example

JSON:

{
  "status": 200,
  "response": {
    "max_step" : 15, // number of issued steps
    "steps" : 2, // number of played steps
    "total_win" : "15000"
  }
}