{ "openapi": "3.1.0", "info": { "title": "Slotserv operator API", "version": "1.2", "description": "Game launch and the games feed, which you call on Slotserv, and the five wallet callbacks, which Slotserv calls on your endpoint (listed as webhooks). Values in angle brackets are placeholders: , and come from your Slotserv onboarding. The full guide is in the Slotserv portal under Documentation." }, "servers": [ { "url": "https://{wallet_host}", "variables": { "wallet_host": { "default": "", "description": "Issued by Slotserv." } } } ], "paths": { "/start": { "get": { "operationId": "launchGame", "summary": "Open a game for a player", "description": "Point the player's browser at this URL. The parameter list is strict: an unknown parameter is a 400. In real mode Slotserv first calls your getbalance.", "parameters": [ { "name": "nogsgameid", "in": "query", "required": true, "description": "A game_id from the games feed.", "schema": { "type": "string" }, "example": "" }, { "name": "nogsoperatorid", "in": "query", "required": true, "description": "Your operator id.", "schema": { "type": "string" }, "example": "" }, { "name": "sessionid", "in": "query", "required": true, "description": "Your operator id, an underscore, then your session token. Wallet callbacks carry it back as gamesessionid.", "schema": { "type": "string" }, "example": "_3f9c2a7e5b1d" }, { "name": "device_type", "in": "query", "required": true, "description": "desktop or mobile. Picks the game page.", "schema": { "type": "string", "enum": [ "desktop", "mobile" ] }, "example": "desktop" }, { "name": "nogscurrency", "in": "query", "required": true, "description": "The player currency. One not enabled for you falls back to your first currency.", "schema": { "type": "string" }, "example": "EUR" }, { "name": "nogslang", "in": "query", "required": true, "description": "The game language.", "schema": { "type": "string" }, "example": "en" }, { "name": "nogsmode", "in": "query", "required": true, "description": "real or demo. Demo mode skips the launch balance check.", "schema": { "type": "string", "enum": [ "real", "demo" ] }, "example": "real" }, { "name": "accountid", "in": "query", "required": true, "description": "Your player id. Wallet callbacks carry it back. Keep underscores out of it.", "schema": { "type": "string" }, "example": "player-42" }, { "name": "homeurl", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "https://casino.example/lobby" }, { "name": "historyUrl", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "https://casino.example/history" }, { "name": "exitUrl", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "https://casino.example/lobby" }, { "name": "country", "in": "query", "required": true, "description": "Required. The launch country comes from your Slotserv configuration.", "schema": { "type": "string" }, "example": "MT" }, { "name": "is_test_account", "in": "query", "required": true, "description": "true or false.", "schema": { "type": "string", "enum": [ "true", "false" ] }, "example": "false" }, { "name": "license", "in": "query", "required": true, "description": "Required, any non-empty text. Not used by Slotserv today.", "schema": { "type": "string" }, "example": "example" }, { "name": "rc_url", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "https://casino.example/reality-check" }, { "name": "realityCheckElapsed", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "0" }, { "name": "realityCheckInterval", "in": "query", "description": "Accepted, not used by Slotserv today.", "schema": { "type": "string" }, "example": "60" } ], "responses": { "200": { "description": "The game page.", "content": { "text/html": { "schema": { "type": "string" } } } }, "302": { "description": "Real mode only: your getbalance answered with message exactly \"Auth error\". The player is sent to your account home URL." }, "400": { "$ref": "#/components/responses/Error", "description": "`: `: A parameter is missing, has a bad value, or is not in the list above. `Invalid operator id`: nogsoperatorid is not a Slotserv operator. `Invalid game id`: nogsgameid is unknown, or the game has no page for this device_type." }, "403": { "$ref": "#/components/responses/Error", "description": "`Game not available`: The game, its vendor or its provider is not enabled for you." }, "500": { "$ref": "#/components/responses/Error", "description": "`Error launching game`: Slotserv could not open the game, or an Auth error redirect found no home URL on your account." } } } }, "/games/feed": { "get": { "operationId": "listGames", "summary": "List the games enabled for you", "description": "Send exactly one of operatorId, clientId or client_id. The first one present wins. The feed is public and needs no credentials.", "parameters": [ { "name": "operatorId", "in": "query", "description": "Your operator id. Send exactly one of operatorId, clientId, client_id.", "schema": { "type": "string" }, "example": "" }, { "name": "clientId", "in": "query", "description": "Your operator id. Send exactly one of operatorId, clientId, client_id.", "schema": { "type": "string" }, "example": "" }, { "name": "client_id", "in": "query", "description": "Your operator id. Send exactly one of operatorId, clientId, client_id.", "schema": { "type": "string" }, "example": "" } ], "responses": { "200": { "description": "The games you can launch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GamesFeed" } } } }, "400": { "$ref": "#/components/responses/Error", "description": "`missing_operator_id`: None of operatorId, clientId, client_id was sent." }, "403": { "$ref": "#/components/responses/Error", "description": "`inactive_operator`: The operator is not active." }, "404": { "$ref": "#/components/responses/Error", "description": "`unknown_operator`: The operator id is not a Slotserv operator." } } } } }, "webhooks": { "getbalance": { "get": { "operationId": "getbalance", "summary": "Read the player's balance", "description": "Slotserv calls `GET https://?request=getbalance&…` with the parameters in this order. It waits 3 seconds for the reply and never retries.", "parameters": [ { "name": "request", "in": "query", "required": true, "description": "Which callback this is.", "schema": { "type": "string", "const": "getbalance" }, "example": "getbalance" }, { "$ref": "#/components/parameters/accountid" }, { "$ref": "#/components/parameters/apiversion" }, { "$ref": "#/components/parameters/device" }, { "name": "nogsgameid", "in": "query", "required": true, "description": "Not a feed game id. 82600156, or the game page code on the launch check. Ignore it.", "schema": { "type": "string" }, "example": "82600156" }, { "$ref": "#/components/parameters/gamesessionid" }, { "$ref": "#/components/parameters/hash" }, { "$ref": "#/components/parameters/timestamp" } ], "responses": { "200": { "description": "Success needs both code 200 and status \"Success\", plus the balance after the change. Any other body counts as a failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletReply" } } } } } } }, "wager": { "get": { "operationId": "wager", "summary": "Take a stake from the balance", "description": "Slotserv calls `GET https://?request=wager&…` with the parameters in this order. It waits 3 seconds for the reply and never retries.", "parameters": [ { "name": "request", "in": "query", "required": true, "description": "Which callback this is.", "schema": { "type": "string", "const": "wager" }, "example": "wager" }, { "$ref": "#/components/parameters/accountid" }, { "$ref": "#/components/parameters/apiversion" }, { "name": "betamount", "in": "query", "required": true, "description": "The stake to take from the balance. Decimal text with trailing zeros removed.", "schema": { "type": "string" }, "example": "1.5" }, { "$ref": "#/components/parameters/gameid" }, { "$ref": "#/components/parameters/device" }, { "$ref": "#/components/parameters/roundid" }, { "$ref": "#/components/parameters/transactionid" }, { "$ref": "#/components/parameters/gamesessionid" }, { "$ref": "#/components/parameters/meta" }, { "$ref": "#/components/parameters/subtype" }, { "$ref": "#/components/parameters/hash" }, { "$ref": "#/components/parameters/timestamp" } ], "responses": { "200": { "description": "Success needs both code 200 and status \"Success\", plus the balance after the change. Any other body counts as a failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletReply" } } } } } } }, "result": { "get": { "operationId": "result", "summary": "Add a win to the balance", "description": "Slotserv calls `GET https://?request=result&…` with the parameters in this order. It waits 3 seconds for the reply and never retries.", "parameters": [ { "name": "request", "in": "query", "required": true, "description": "Which callback this is.", "schema": { "type": "string", "const": "result" }, "example": "result" }, { "$ref": "#/components/parameters/accountid" }, { "$ref": "#/components/parameters/apiversion" }, { "name": "result", "in": "query", "required": true, "description": "The win to add to the balance. Decimal text with trailing zeros removed.", "schema": { "type": "string" }, "example": "1.5" }, { "name": "gamestatus", "in": "query", "required": true, "description": "Always completed.", "schema": { "type": "string" }, "example": "completed" }, { "$ref": "#/components/parameters/gameid" }, { "$ref": "#/components/parameters/device" }, { "$ref": "#/components/parameters/roundid" }, { "$ref": "#/components/parameters/gamesessionid" }, { "$ref": "#/components/parameters/transactionid" }, { "$ref": "#/components/parameters/meta" }, { "$ref": "#/components/parameters/subtype" }, { "$ref": "#/components/parameters/hash" }, { "$ref": "#/components/parameters/timestamp" } ], "responses": { "200": { "description": "Success needs both code 200 and status \"Success\", plus the balance after the change. Any other body counts as a failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletReply" } } } } } } }, "rollback": { "get": { "operationId": "rollback", "summary": "Return a stake taken by an earlier wager", "description": "Slotserv calls `GET https://?request=rollback&…` with the parameters in this order. It waits 3 seconds for the reply and never retries.", "parameters": [ { "name": "request", "in": "query", "required": true, "description": "Which callback this is.", "schema": { "type": "string", "const": "rollback" }, "example": "rollback" }, { "$ref": "#/components/parameters/accountid" }, { "$ref": "#/components/parameters/apiversion" }, { "name": "rollbackamount", "in": "query", "required": true, "description": "The stake to return to the balance. Decimal text with trailing zeros removed.", "schema": { "type": "string" }, "example": "1.5" }, { "$ref": "#/components/parameters/gameid" }, { "$ref": "#/components/parameters/device" }, { "$ref": "#/components/parameters/roundid" }, { "$ref": "#/components/parameters/gamesessionid" }, { "$ref": "#/components/parameters/transactionid" }, { "$ref": "#/components/parameters/meta" }, { "$ref": "#/components/parameters/hash" }, { "$ref": "#/components/parameters/timestamp" } ], "responses": { "200": { "description": "Success needs both code 200 and status \"Success\", plus the balance after the change. Any other body counts as a failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletReply" } } } } } } }, "roundinfo": { "get": { "operationId": "roundinfo", "summary": "Report the movements of a finished round", "description": "Slotserv calls `GET https://?request=roundinfo&…` with the parameters in this order. It moves no money: wager, result and rollback already settled the round. It waits 3 seconds for the reply and never retries.", "parameters": [ { "name": "request", "in": "query", "required": true, "description": "Which callback this is.", "schema": { "type": "string", "const": "roundinfo" }, "example": "roundinfo" }, { "$ref": "#/components/parameters/accountid" }, { "$ref": "#/components/parameters/apiversion" }, { "name": "transactions", "in": "query", "required": true, "description": "The provider's movements for the round, as JSON text. An empty round sends [].", "schema": { "type": "string" }, "example": "[{\"action\":\"bet\",\"amount\":\"1.5\"}]" }, { "name": "gameid", "in": "query", "required": true, "description": "The round this report is about. Sent even when empty.", "schema": { "type": "string" }, "example": "rnd-1001" }, { "$ref": "#/components/parameters/hash" }, { "$ref": "#/components/parameters/timestamp" } ], "responses": { "200": { "description": "Success needs both code 200 and status \"Success\", plus the balance. A reply without a balance counts as a failure even though the request moves no money.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WalletReply" } } } } } } } }, "components": { "parameters": { "accountid": { "name": "accountid", "in": "query", "required": true, "description": "Your player id, as you passed it to /start.", "schema": { "type": "string" }, "example": "player-42" }, "apiversion": { "name": "apiversion", "in": "query", "required": true, "description": "Always 1.2.", "schema": { "type": "string" }, "example": "1.2" }, "device": { "name": "device", "in": "query", "required": true, "description": "Always desktop.", "schema": { "type": "string" }, "example": "desktop" }, "gamesessionid": { "name": "gamesessionid", "in": "query", "required": true, "description": "The sessionid you passed to /start. Use it to find the player session.", "schema": { "type": "string" }, "example": "4200_3f9c2a7e5b1d" }, "hash": { "name": "hash", "in": "query", "description": "Only when request verification is on. sha256 signature over the request. See Request verification.", "schema": { "type": "string" }, "example": "<64 hex characters>" }, "timestamp": { "name": "timestamp", "in": "query", "description": "Only when request verification is on. Unix seconds when Slotserv signed the request.", "schema": { "type": "string" }, "example": "1767225600" }, "gameid": { "name": "gameid", "in": "query", "description": "The game code for this round, when the provider sends one.", "schema": { "type": "string" }, "example": "demo-slot-01" }, "roundid": { "name": "roundid", "in": "query", "description": "The game round this movement belongs to.", "schema": { "type": "string" }, "example": "rnd-1001" }, "transactionid": { "name": "transactionid", "in": "query", "description": "Unique per money movement. A repeat must not move money twice.", "schema": { "type": "string" }, "example": "txn-5001" }, "meta": { "name": "meta", "in": "query", "description": "The provider's action details, as JSON text.", "schema": { "type": "string" }, "example": "{\"table\":\"7\"}" }, "subtype": { "name": "subtype", "in": "query", "description": "The provider's subtype for this movement.", "schema": { "type": "string" }, "example": "freespin" } }, "schemas": { "WalletReply": { "oneOf": [ { "$ref": "#/components/schemas/WalletSuccess" }, { "$ref": "#/components/schemas/WalletError" } ] }, "WalletSuccess": { "type": "object", "required": [ "code", "status", "balance" ], "properties": { "code": { "const": 200 }, "status": { "const": "Success" }, "balance": { "description": "The balance after the change. A number or a numeric string.", "type": [ "number", "string" ] } }, "example": { "code": 200, "status": "Success", "balance": 100.5 } }, "WalletError": { "type": "object", "required": [ "message" ], "properties": { "code": { "type": "integer" }, "status": { "type": "string" }, "message": { "type": "string", "description": "Matched without regard to case, first match wins: \"Player session not found\", \"Not logged on\", \"Insufficient balance to place a bet\", \"Insufficient funds\", \"Round closed or transaction id exists\", \"Auth error\", \"Technical error\". Any other text counts as a generic failure.", "examples": [ "Player session not found", "Not logged on", "Insufficient balance to place a bet", "Insufficient funds", "Round closed or transaction id exists", "Auth error", "Technical error" ] } }, "example": { "code": 401, "status": "Error", "message": "Auth error" } }, "GamesFeed": { "type": "object", "required": [ "games" ], "properties": { "games": { "type": "array", "items": { "type": "object", "required": [ "game_id", "name", "image", "categories", "provider", "demo" ], "properties": { "game_id": { "type": "string", "description": "Pass it to /start as nogsgameid." }, "name": { "type": "string", "description": "The game name." }, "image": { "type": [ "string", "null" ], "description": "Image URL, or null." }, "categories": { "type": "array", "items": { "type": "string" }, "description": "Every category of the game, in English. Empty when it has none." }, "provider": { "type": [ "string", "null" ], "description": "Provider name, or null." }, "demo": { "type": "boolean", "description": "Whether nogsmode=demo works for this game." } } } } } }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } } }, "responses": { "Error": { "description": "An error with a JSON body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }