{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Definitions","type":"basic","slug":"definitions","excerpt":"","body":"This page holds definitions of the terms used in the Spigo API.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Term\",\n    \"h-1\": \"Definition\",\n    \"0-0\": \"game\",\n    \"0-1\": \"A singleplayer or multiplayer game on the Spigo platform - e.g. Backgammon.\",\n    \"3-0\": \"player\",\n    \"4-0\": \"playerId\",\n    \"3-1\": \"A \\\"player\\\" is the game platform’s representation of a partner’s user.\",\n    \"5-0\": \"playerIdentifier\",\n    \"6-0\": \"playerPartnerIdentifier\",\n    \"7-0\": \"gameRequest\",\n    \"8-0\": \"gameRequestId\",\n    \"9-0\": \"gameSession\",\n    \"10-0\": \"gameSessionId\",\n    \"11-0\": \"gameSessionIdentifier\",\n    \"12-0\": \"partnerSessionIdentifier\",\n    \"13-0\": \"transactionId\",\n    \"14-0\": \"jackpot\",\n    \"15-0\": \"jackpotIdentifier\",\n    \"16-0\": \"ruleId\",\n    \"17-0\": \"money\",\n    \"17-1\": \"Money is always in minor currency and confoms with the specified currencyISO4217.\",\n    \"16-1\": \"An id of the ruleSet used in a particular gameSession. A ruleSet is a collection of one or more rule choices made regarding a game's setup - a rule choice could be e.g. if a game of Yatzy is played with 5 or 6 dice.\",\n    \"15-1\": \"Each jackpot has a unique uuid. Tje jackpotIdentifier constitutes this uuid.\",\n    \"14-1\": \"A game can have a jackpot. The jackpot is comprised of one major prize which is funded by rake percentages and a list of minor prizes which have a fixed value.\",\n    \"13-1\": \"A unique id sent with state changing events concerning gameRequests and gameSessions. When a gameRequest is made using \\\"gameRequestBuy\\\" the partner must register the transactionId as it may later be used to check on the validity of the gameRequest using the request \\\"gameRequestCheckValid\\\".\",\n    \"12-1\": \"Partner’s identifier for the game session (supplied when opening the GameHub).\\nHas a maximum length of 50.\",\n    \"11-1\": \"Each gameSession has a unique uuid. It serves as a public id for the game.\",\n    \"10-1\": \"Each gameSession has a unique integer id.\",\n    \"9-1\": \"One or more valid gameRequests (i.e. gameRequests where money for the stake was successfully withdrawn from the player wallet) may be combined into a gameSession. A gameSession encapsulates the activity of executing a specific game. For instance the activity of two players playing Backgammon.\",\n    \"8-1\": \"Each gameRequest has a unique integer id.\",\n    \"7-1\": \"When a player wants to play a game her client sends a gameRequest to the game platform. A gameRequest results in a wallet purchase where funds covering the games stake are deducted from the player’s wallet.\",\n    \"6-1\": \"Each player has a String identifier identifying it to the partner’s corresponding user. A playerPartnerIdentifier is only unique when paired with its partner. The playerPartnerIdentifier is intended so a partner does not need to store the game platform’s reference to each user.\",\n    \"5-1\": \"Each player has a unique uuid. It serves as a public id for the game communicated to the partn.\",\n    \"4-1\": \"Each player has a unique internal integer id in the Spigo backend.\",\n    \"1-0\": \"gameId\",\n    \"1-1\": \"Each game has a unique integer id used internally in Spigo's backend.\",\n    \"2-0\": \"partner\",\n    \"2-1\": \"A company who integrates its own platform with Spigo's gaming platform. In the most common sense the partner is a games operator.\",\n    \"18-0\": \"loyalty\",\n    \"18-1\": \"Loyalty is an optional \\\"currency\\\" which can be earned by plaing money games. Each loyalty point is worth some amount of real currency - usually a small fraction of a currency unit. It is possible for Spigo to store a player's loyalty. To this end the API has a method allowing the partner to withdraw earned loyalty from a player's account.\",\n    \"19-0\": \"site\",\n    \"19-1\": \"A partner has one or more sites. A site has its own API callback url and can have its own configuration of games and stakes. For partners with multiple casinos it can make sense to have a site per casino.\",\n    \"20-0\": \"siteId\",\n    \"20-1\": \"Each site is identified by a siteId.\",\n    \"21-0\": \"Player network\",\n    \"21-1\": \"A partner is always part of a player network. Partners can share player networks. Players in the same player network can be matched with  each other in multiplayer games.\"\n  },\n  \"cols\": 2,\n  \"rows\": 22\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5a55b149f85c3a0032f10e60","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Documentation","slug":"documentation","order":0,"from_sync":false,"reference":false,"_id":"5a55b149f85c3a0032f10e56","version":"5a55b149f85c3a0032f10e55","project":"550dd1756c0b4c0d00fd436e","createdAt":"2015-03-21T20:15:50.122Z","__v":0},"parentDoc":null,"project":"550dd1756c0b4c0d00fd436e","user":"5514315e67d97f2500b774ed","version":{"version":"1.5","version_clean":"1.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5a55b149f85c3a0032f10e56","5a55b149f85c3a0032f10e57","5a55b149f85c3a0032f10e58","5a55b149f85c3a0032f10e59","5a55b149f85c3a0032f10e5a","5a55b149f85c3a0032f10e5b","5a55b149f85c3a0032f10e5c","5a55b149f85c3a0032f10e5d","5d1da68fa911a50226595581"],"_id":"5a55b149f85c3a0032f10e55","project":"550dd1756c0b4c0d00fd436e","createdAt":"2018-01-10T06:23:05.406Z","releaseDate":"2018-01-10T06:23:05.406Z","__v":2},"createdAt":"2016-05-09T19:53:47.057Z","githubsync":"","__v":0}
This page holds definitions of the terms used in the Spigo API. [block:parameters] { "data": { "h-0": "Term", "h-1": "Definition", "0-0": "game", "0-1": "A singleplayer or multiplayer game on the Spigo platform - e.g. Backgammon.", "3-0": "player", "4-0": "playerId", "3-1": "A \"player\" is the game platform’s representation of a partner’s user.", "5-0": "playerIdentifier", "6-0": "playerPartnerIdentifier", "7-0": "gameRequest", "8-0": "gameRequestId", "9-0": "gameSession", "10-0": "gameSessionId", "11-0": "gameSessionIdentifier", "12-0": "partnerSessionIdentifier", "13-0": "transactionId", "14-0": "jackpot", "15-0": "jackpotIdentifier", "16-0": "ruleId", "17-0": "money", "17-1": "Money is always in minor currency and confoms with the specified currencyISO4217.", "16-1": "An id of the ruleSet used in a particular gameSession. A ruleSet is a collection of one or more rule choices made regarding a game's setup - a rule choice could be e.g. if a game of Yatzy is played with 5 or 6 dice.", "15-1": "Each jackpot has a unique uuid. Tje jackpotIdentifier constitutes this uuid.", "14-1": "A game can have a jackpot. The jackpot is comprised of one major prize which is funded by rake percentages and a list of minor prizes which have a fixed value.", "13-1": "A unique id sent with state changing events concerning gameRequests and gameSessions. When a gameRequest is made using \"gameRequestBuy\" the partner must register the transactionId as it may later be used to check on the validity of the gameRequest using the request \"gameRequestCheckValid\".", "12-1": "Partner’s identifier for the game session (supplied when opening the GameHub).\nHas a maximum length of 50.", "11-1": "Each gameSession has a unique uuid. It serves as a public id for the game.", "10-1": "Each gameSession has a unique integer id.", "9-1": "One or more valid gameRequests (i.e. gameRequests where money for the stake was successfully withdrawn from the player wallet) may be combined into a gameSession. A gameSession encapsulates the activity of executing a specific game. For instance the activity of two players playing Backgammon.", "8-1": "Each gameRequest has a unique integer id.", "7-1": "When a player wants to play a game her client sends a gameRequest to the game platform. A gameRequest results in a wallet purchase where funds covering the games stake are deducted from the player’s wallet.", "6-1": "Each player has a String identifier identifying it to the partner’s corresponding user. A playerPartnerIdentifier is only unique when paired with its partner. The playerPartnerIdentifier is intended so a partner does not need to store the game platform’s reference to each user.", "5-1": "Each player has a unique uuid. It serves as a public id for the game communicated to the partn.", "4-1": "Each player has a unique internal integer id in the Spigo backend.", "1-0": "gameId", "1-1": "Each game has a unique integer id used internally in Spigo's backend.", "2-0": "partner", "2-1": "A company who integrates its own platform with Spigo's gaming platform. In the most common sense the partner is a games operator.", "18-0": "loyalty", "18-1": "Loyalty is an optional \"currency\" which can be earned by plaing money games. Each loyalty point is worth some amount of real currency - usually a small fraction of a currency unit. It is possible for Spigo to store a player's loyalty. To this end the API has a method allowing the partner to withdraw earned loyalty from a player's account.", "19-0": "site", "19-1": "A partner has one or more sites. A site has its own API callback url and can have its own configuration of games and stakes. For partners with multiple casinos it can make sense to have a site per casino.", "20-0": "siteId", "20-1": "Each site is identified by a siteId.", "21-0": "Player network", "21-1": "A partner is always part of a player network. Partners can share player networks. Players in the same player network can be matched with each other in multiplayer games." }, "cols": 2, "rows": 22 } [/block]