Recommendations API is an API for providing recommendations to an Operator for game lobbies, user lobbies and games based on user's interactions (gameplays) on Nirova platform.
POST /recommendations/lobby HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"operator_id": 1,
"platform": "GPL_DESKTOP",
"user": "johndoe",
"language": "en",
"currency": "EUR",
"location": "JPN",
"limit": "50"
}
Game lobby recommendation:
The endpoint provides a list of recommended top games based on overall unique users’ interactions with the games. The list of games returned is sorted and scored from high to low, a higher score indicates an increased possibility of interaction with the game.
uX-Nirova-Signature - any · required
RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.
operator_id - integer · required
Unique identifier for the Operator in Nirova system. Used to authorize incoming requests. You can obtain your operator_id from the Nirova BackOffice after your Operator entity is registered and set up in the Nirova system by the internal teams.
Example: 1
platform - string · required
The device platform type for which game recommendations are provided. It's the current device platform the user is accessing the Operator's site from.
Example: GPL_DESKTOP
user - string · optional
The unique user name of the user on Operator's side. The parameter is required to reference if a user exists on Nirova platform, i.e. has launched a game at least once.
Example: johndoe
language - string · optional
The language enabled for the user on the site, used to help improve the quality of recommendations. Optional context parameter.
Example: en
currency - string · optional
The currency which has been currently enabled for the wallet on the site. This value can be provided to help improve the quality of recommendations, in a situation where user switches between multiple wallets (currencies) to play games on the site. Optional context parameter.
Example: EUR
location - string · optional
The country location provided to help improve the quality of the recommendation in a situation user plays from multiple locations (countries). Optional context parameter.
Example: JPN
limit - integer · optional
The limits for the count of returned game recommendations. Default limit: 50, Maximum limit: 500.
Example: 50
{
"games": [
{
"url_thumb": "https://picture-hosting.com/blackjack/thumb.png",
"url_background": "https://picture-hosting.com/blackjack/bg.png",
"product": "OneTouch",
"platforms": [
"GPL_DESKTOP",
"GPL_MOBILE"
],
"name": "Classic",
"game_code": "ont_classic",
"reward_support": true,
"enabled": true,
"category": "Blackjack",
"blocked_countries": [
"PL",
"BG"
],
"release_date": "2024-11-05",
"scatters": true,
"in_game_rewards": true,
"volatility": 6,
"rtp": "94.79",
"paylines": 20,
"hit_ratio": "24.47",
"certifications": [
"CURACAO"
],
"languages": [
"eng",
"jpn",
"kor",
"deu"
],
"theme": [
[
"Nature",
"Halloween",
"Horror"
]
],
"technology": [
[
"HTML5"
]
],
"score": "0.015"
}
],
"recommendation_id": "RID-65d1700a-00af-4a90-a554-9304f4c181d6"
}{
"error": "Bad request"
}
POST /recommendations/user_lobby HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 122
{
"operator_id": 1,
"platform": "GPL_DESKTOP",
"user": "johndoe",
"language": "en",
"currency": "EUR",
"location": "JPN",
"limit": "50"
}
User personalized lobby:
The endpoint provides a list of recommended top games based on overall unique users’ interactions with the games. The list of games returned is sorted and scored from high to low, a higher score indicates an increased possibility of interaction with the game.
uX-Nirova-Signature - any · required
RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.
operator_id - integer · required
Unique identifier for the Operator in Nirova system. Used to authorize incoming requests. You can obtain your operator_id from the Nirova BackOffice after your Operator entity is registered and set up in the Nirova system by the internal teams.
Example: 1
platform - string · required
The device platform type for which game recommendations are provided. It's the current device platform the user is accessing the Operator's site from.
Example: GPL_DESKTOP
user - string · optional
The unique user name of the user on Operator's side. The parameter is required to reference if a user exists on Nirova platform, i.e. has launched a game at least once.
Example: johndoe
language - string · optional
The language enabled for the user on the site, used to help improve the quality of recommendations. Optional context parameter.
Example: en
currency - string · optional
The currency which has been currently enabled for the wallet on the site. This value can be provided to help improve the quality of recommendations, in a situation where user switches between multiple wallets (currencies) to play games on the site. Optional context parameter.
Example: EUR
location - string · optional
The country location provided to help improve the quality of the recommendation in a situation user plays from multiple locations (countries). Optional context parameter.
Example: JPN
limit - integer · optional
The limits for the count of returned game recommendations. Default limit: 50, Maximum limit: 500.
Example: 50
{
"games": [
{
"url_thumb": "https://picture-hosting.com/blackjack/thumb.png",
"url_background": "https://picture-hosting.com/blackjack/bg.png",
"product": "OneTouch",
"platforms": [
"GPL_DESKTOP",
"GPL_MOBILE"
],
"name": "Classic",
"game_code": "ont_classic",
"reward_support": true,
"enabled": true,
"category": "Blackjack",
"blocked_countries": [
"PL",
"BG"
],
"release_date": "2024-11-05",
"scatters": true,
"in_game_rewards": true,
"volatility": 6,
"rtp": "94.79",
"paylines": 20,
"hit_ratio": "24.47",
"certifications": [
"CURACAO"
],
"languages": [
"eng",
"jpn",
"kor",
"deu"
],
"theme": [
[
"Nature",
"Halloween",
"Horror"
]
],
"technology": [
[
"HTML5"
]
],
"score": "0.015"
}
],
"recommendation_id": "RID-65d1700a-00af-4a90-a554-9304f4c181d6"
}{
"error": "Bad request"
}
POST /recommendations/similar_games HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 133
{
"operator_id": 1,
"platform": "GPL_DESKTOP",
"game_code": "evo_crazytime",
"language": "en",
"currency": "EUR",
"location": "JPN",
"limit": "50"
}
Similar games recommendation:
Endpoint recommends similar games to the game requested based on co-occurrence of interactions (game plays) on the requested game and other games in all recorded game plays on Nirova platform.
The response game list contains popular games played by other users, who have also played the game in the request.
uX-Nirova-Signature - any · required
RSA-SHA256 is used to sign the request body using the private key. The signature is validated using the public key associated with the provided operator_id.
operator_id - integer · required
Unique identifier for the Operator in Nirova system. Used to authorize incoming requests. You can obtain your operator_id from the Nirova BackOffice after your Operator entity is registered and set up in the Nirova system by the internal teams.
Example: 1
platform - string · required
The platform of the device Game gets recommendations for.
Example: GPL_DESKTOP
game_code - string · required
The Game reference code to recommend similar games for.
Example: evo_crazytime
language - string · optional
The language enabled for the user on the site, used to help improve the quality of recommendations. Optional context parameter.
Example: en
currency - string · optional
The currency which has been currently enabled for the wallet on the site. This value can be provided to help improve the quality of recommendations, in a situation where user switches between multiple wallets (currencies) to play games on the site. Optional context parameter.
Example: EUR
location - string · optional
The country location provided to help improve the quality of the recommendation in a situation user plays from multiple locations (countries). Optional context parameter.
Example: JPN
limit - integer · optional
Limits the count of returned games in the response. Maximum is 500.
Example: 50
{
"games": [
{
"url_thumb": "https://picture-hosting.com/blackjack/thumb.png",
"url_background": "https://picture-hosting.com/blackjack/bg.png",
"product": "OneTouch",
"platforms": [
"GPL_DESKTOP",
"GPL_MOBILE"
],
"name": "Classic",
"game_code": "ont_classic",
"reward_support": true,
"enabled": true,
"category": "Blackjack",
"blocked_countries": [
"PL",
"BG"
],
"release_date": "2024-11-05",
"scatters": true,
"in_game_rewards": true,
"volatility": 6,
"rtp": "94.79",
"paylines": 20,
"hit_ratio": "24.47",
"certifications": [
"CURACAO"
],
"languages": [
"eng",
"jpn",
"kor",
"deu"
],
"theme": [
[
"Nature",
"Halloween",
"Horror"
]
],
"technology": [
[
"HTML5"
]
],
"score": "0.015"
}
],
"recommendation_id": "RID-65d1700a-00af-4a90-a554-9304f4c181d6"
}{
"error": "Bad request"
}