Skip to main content

Open Game

Obtain the player's game launch URL

API Information​

  • URL：POST /v2/opengame
  • Authentication：Bearer Token
  • Encryption：Requests are encrypted using AES-256-GCM; responses are returned as plaintext JSON

request​

request Headers​

POST /v2/opengame HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
x-agentid: integratorNBTest04
x-timestamp: 1769746894501
x-nonce: 56ffd5ecd8a3a4457863a0bd7c298fb2
x-signature: c25f8d23704373e8776cce6d9b10f1fde091c34db80d60523c7e04ff30e54633

Request Parameters​

Request Body Before Encryption​

{
  "deviceType": 0,
  "ipaddress": "35.200.72.205",
  "lang": "en",
  "lobbyUrl": "https://example.com",
  "gameCode": "VP_230001_1",
  "launchType": 1,
  "username": "testaccount01"
}

Encrypted Request Body​

{
  "cipherText": "G0ZMDELeJwx+7JcIfIFOLJjkSzANPu6krGM2uw==..."
}
FieldTypeRequiredDescription
deviceTypenumberYesDevice type: 0: PC, 1: Mobile device
ipaddressstringYesLogin IP
langstringYesLanguage
gameCodestringYesGame Code
launchTypenumberYesPlay Modes
lobbyUrlstringNoWhen the system displays an error message, the specified link used for the return message
usernamestringNoPlayer Account

Response​

Success Response​

{
  "code": 0,
  "message": "No error.",
  "data": {
    "gameLaunchHtml": null,
    "gameLaunchUrl": "https://staggp.zzzstkk.com/game/230001/3.55.0?a=integratorNBTest04_VPSysDevTest010&g=230001&p=3UWzoOtmcKcdZbQnEiHwHbBn9i3w4y__R_DuvopsoYemrFfczHqZGciqR5YvDkTn...",
    "mode": "real"
  },
  "logUUID": "23c50208-cd0f-4daa-be3c-f346da188107"
}
FieldTypeDescription
gameLaunchHtmlstringnull
gameLaunchUrlstringURL used to launch the game
modestringEnable game mode
logUUIDstringRequest tracking ID for troubleshooting and log queries

Error Response​

When the request fails, the corresponding error code will be returned.

Error Codes​

CodeDescriptionHandling Suggestion
5Game is not foundThe game does not exist, has been taken offline, or does not support the specified currency. Please verify that the gameCode is correct.
7Internal server errorAn internal system error occurred. Please try again later or contact technical support.
8The User is not existMember does not exist. Please create the member first.
11Parameters errorEnsure that all request parameters are complete and correctly formatted
19Invalid accountThe account is invalid. Please check the Player Account.
81Branch config not foundBranch configuration not found. Please contact technical support.
82Please check siteId is for this playerPlease verify that the siteId corresponds to the specified player.

Error Response Example​

{
  "code": 5,
  "message": "Game is not found",
  "logUUID": "24cdc3b9-9fe8-44de-8391-a96863e46954"
}
{
  "code": 8,
  "message": "The User is not exist",
  "logUUID": "24cdc3b9-9fe8-44de-8391-a96863e46954"
}

Important Notes​

Special Notes​

  1. ipaddress Usage Restrictions:

    • Only one IP address can be provided
    • If launchType is 1 (demo mode), a virtual IP may be used

  2. Relationship Between username and launchType:

    • When launchType is 1 (demo mode), username may be empty or omitted
    • When launchType is 0 (both) or 2 (real), username is required

  3. lobbyUrl Format Requirements:

    • If lobbyUrl is provided, the URL must use the HTTPS protocol

General Notes​

  1. URL Validity:

    • Game URLs are typically valid for 5 minutes
    • A new URL must be obtained after expiration
    • Each URL can only be used once

  2. Return Handling:

    • lobbyUrl will be used when the player closes the game
    • It is recommended to set this to the game lobby page

  3. Game Mode:

    • When launchType is 2 (real), only the real-money mode is available.
    • When launchType is 1 (demo), only the demo mode is available.
    • When launchType is 0 (both), players can choose between real-money mode or demo mode on the game screen.
    • Demo mode can be played without a player account; if an account is provided, the player can switch to real-money mode within the game.

  4. Concurrency Limits:

    • A single member can have only one active game url at a time (dual game are not supported).
    • Launching a new game will automatically close the previous url.