Game API

The Game API offers methods for launching games. All requests are passed from the operator to VeliGames using the HTTP POST method with the content type application/json. The signature parameter is mandatory for all requests.

See also

Authentication

API Method: providers

The operator makes a request to the providers endpoint for a list of all available game providers under their profile.

Path:

https://VELIGAMES_API_URL/game-lists/public/providers

HTTP Method:

POST

Request body

Schema:

GetProvidersRequest

A request to the providers endpoint passes the following parameters. A response with a lengthy list of providers is multi-paged. To iterate over the list or to request a specific list chunk, use the optional page parameter.

Param	Type	Description
brandId	string	The identifier of the casino brand
extraData (optional)	boolean	Additional information about the provider, such as supported currencies. Default: false
size (optional)	number	The maximum number of providers to return on a single page. Default: 20
page (optional)	number	The requested page, (counting from 1). Default: 1

An example of the providers API method

curl 'https://VELIGAMES_API_URL/game-lists/public/providers' \
--header 'signature: OPERATOR_ID:vVh+FCw....3M5EsKxeSS6+gA==' \
--header 'Content-Type: application/json' \
--data '{
           "brandId": "someBrand",
           "size": 5
}'
Copy code

JSON Response

Schema:

• GetProvidersResponseSchema

• PaginationMetaSchema

The response includes a list of providers in an array of ProviderInfoSchema objects under the items parameter. Information about the pagination is found in the meta parameter.

The items parameter contains the following information:

Param	Type	Description
items	[ProviderInfoDto]	A list of instances of the ProviderInfoSchema object which contain information about the providers that satisfy the criteria in the matching request.
meta	PaginationMetaDto	If the list of providers is long then details about the portion of providers returned in this response are included in this element as an instance of the PaginationMetaSchema object.

Details about the pagination under meta contain:

Param	Type	Description
totalItems	number	The total number of items in the collection that matches the request.
itemCount	number	The number of items returned in this particular response
itemsPerPage	number	The maximum number of items from the data set that may fit in a page.
totalPages	number	The total number of pages required to deliver the whole collection.
currentPage	number	The current page number for this particular response.

{
   "items": [
        {
            "providerId": "provider1",
            "providerName": "Provider 1",
            "logoForDark": "https://cdn-link/providers/dark/provider1.png",
            "logoForLight": "https://cdn-link/providers/light/provider1.png"
        }
   ],
   "meta": {
        "totalItems": 1,
        "itemCount": 1,
        "itemsPerPage": 5,
        "totalPages": 1,
        "currentPage": 1
   }
}
Copy code

API Method: games

The operator makes a request to the games endpoint for a list of games from the selected game provider.

Path:

https://VELIGAMES_API_URL/game-lists/public/games

HTTP Method:

POST

Request body

Schema:

ProviderGamesRequestSchema

A request to the games endpoint passes the following parameters. To iterate over the list or to request a specific list chunk, use the optional page parameter.

Parameter	Type	Description
brandId	string	The identifier of the casino brand
providerId	string	The unique identifier of the provider
size (optional)	number	The maximum number of games to return on a single page. Default: 20
page (optional)	number	The requested page (counting from 1). Default: 1

An example of the games API method

curl 'https://VELIGAMES_API_URL/game-lists/public/games' \
--header 'signature: OPERATOR_ID:qPOGCXWVEDr....hJRYOlTX2pKqQ==' \
--header 'Content-Type: application/json' \
--data '{
           "brandId": "someBrand",
           "providerId": "provider1"
}'
Copy code

JSON Response

Schema:

ProviderGamesResponseSchema

The response contains a list of games under the items parameter as instances of the GameSchema objects. The meta object contains details about the paged output.

Parameter	Type	Description
items	[GameEntity]	A list of instances of the GameSchema object which contain information about the games that satisfy the criteria in the matching provider games request.
meta (optional)	[PaginationMetaDto]	If the list of games is long then details about the portion of games returned in this response are included in this element as an instance of the PaginationMetaSchema object.

{
    "items": [
         {
             "gameId": "game1",
             "providerId": "provider1",
             "name": "Game 1",
             "deviceType": "DESKTOP_AND_MOBILE",
             "category": "Crash",
             "volatility": "null",
             "rtp": null,
             "hasDemoMode": true,
             "hasFreeBets": false
         }
     ],
     "meta": {
         "totalItems": 1,
         "itemCount": 1,
         "itemsPerPage": 5,
         "totalPages": 1,
         "currentPage": 1
     }
 }
Copy code

API Method: start-game

The operator makes a request to the start-game endpoint to obtain the a valid launch URL for a requested game. Requests to this Game API endpoint must pass the following parameters.

Path:

https://VELIGAMES_API_URL/unified-api/public/start-game

HTTP Method:

POST

Tip

Multiple wallets: There is no need to create a unique player ID per currency

You may use multiple wallets by starting one session with one currency, such as EUR, and another session – with another currency, such as USD according to your supported currencies.

Request body

The following parameters are mandatory. A request is only valid if it contains all of these parameters.

Required Parameter	Type	Description
sessionId	string	Operator’s unique identifier (UUID) for a distinct game session.
providerId	string	Game provider identifier
gameId	string	Game identifier
language	string(2)	A language code (en, fr) for the preferred language for the game
playerId	string	The player’s unique identifier.
currency	string	The player’s currency code [1]
deviceType	string	The type of the device where the game will be run. The permitted values are DESKTOP or MOBILE.
country	string(2)	A 2-letter code that represents the player’s country. [2]
ip	string	The player’s IP address
brandId	string	The identifier of the casino brand (Also known as Agent)

Tip

A request remains valid even if none of the optional parameters appear in the request body.

Optional Parameter	Type	Description
userAgent	string	The player’s user agent, such as browser
lobbyUrl	string	The URL to the lobby of the casino (Highly recommended)
cashierUrl	string	The URL to the cashier of the casino
lobbyId	string	The lobby identifier
playerName	string	The player’s name (Appears in some games)

Important

Player’s ID is a sequence of Latin alphabet characters, either lower or upper case, or digits. It should not exceed 45 characters.

Response body

The response body contains the URL for starting the game in the startGameUrl parameter. Open the game URL on the VeliGames side. Do not change the parameters encoded in this URL.

API Method: start-demo-game

Using this method, the operator receives a valid DEMO launch URL for a requested game. Requests to this Game API endpoint must pass the following parameters.

Path:

https://VELIGAMES_API_URL/unified-api/public/start-demo-game

HTTP Method:

POST

Important

The game you are starting in this mode must have the hasDemoMode parameter set to true.

See also

GameSchema

Request body

The following parameters are mandatory. A request is only valid if it contains all of the following parameters.

Required parameter	Type	Description
providerId	string	The identifier of a game provider
gameId	string	The identifier of a game
language	string(2)	A language code (en, fr) for the preferred language for the game
deviceType	string	The type of the device where the game will be run. The permitted values are DESKTOP or MOBILE
ip	string	The IP address of the player
brandId	string	The identifier of the casino brand (Also known as Agent)

Tip

A request remains valid even if none of the optional parameters appear in the request body.

Optional Parameter	Type	Description
playerId	string	The player’s unique identifier
country	string(2)	A 2-letter code that represents the player’s country [2]
userAgent	string	The player’s user agent, such as browser
lobbyUrl	string	The URL to the lobby of the casino
cashierUrl	string	The URL to the cashier of the casino
lobbyId	string	The lobby identifier
playerName	string	The player’s name

Response body

The response body contains the URL for starting the game in the startGameUrl parameter. The URL to the game must be opened on the VeliGames side. The parameters encoded in this URL may not be altered.

Game API Request Example

The following example demonstrates a call to the API Method: start-game API method using curl. For the sake of example, the operator ID in the signature parameter of the header appears as OPERATOR_ID. A real request would contain the operator ID provided by VeliGames. The HMAC code in the signature has been shortened to fit the page.

curl -X 'POST' \
'https://VELIGAMES_API_URL/unified-api/public/start-game' \
-H 'signature: OPERATOR_ID:G6pRpaYWM...IDaVH4eYvuUNXpyi2PA==' \
-H 'Content-Type: application/json' \
-d '{
        "providerId": "acceptance-tests",
        "gameId": "e2e",
        "language": "en",
        "playerId": "1123...1243",
        "currency": "XAF",
        "deviceType": "MOBILE",
        "country": "GE",
        "brandId": "someBrand",
        "sessionId": "6c210f4...6ba",
        "ip": "192.0.2.0"
    }'
Copy code

Successful JSON response

{
   "startGameUrl": "string"
}
Copy code

Error

{
  "error": "GAME_NOT_FOUND"
}
Copy code

Error Codes

The error protocol of Game API signals about a number of standard problems at runtime. The related errors are returned in the response object by error ID.

Error ID	Status Code	Response from VeliGames to platform
UNKNOWN_ERROR	500	A generic error or an internal server error that can be retried
BAD_REQUEST	400	Missing/invalid parameters in start game
UNAUTHORIZED	401	Invalid signature and/or no access to the requested game.
GAME_NOT_FOUND	404	GameId does not exist
SESSION_EXISTS	409	Session already exists

See also

Authentication

Footnotes

[1]

Currency codes comply with ISO 4217: EUR, USD and so on.

[2] (1,2)

The country code is a 2-letter code according to ISO 3166 alpha-2: UK, DE, GE