Skip to content
Last updated

Player Information

The Player Information request is used for receiving information about the registered player. This request verifies the provided session token value on the Operator side.

In case of non-determined (unpredicted) HTTP server errors with HTTP Status Code 5xx (500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511) from the wallet's side, the failed Player Information request will be retried maximum 10 times with pauses for a fixed period of time equal 1 second between attempts. If the last 10th attempt fails, the request will be rejected and the player will see an error.**

It is not possible to explicitly trigger the Player Information request retry via HTTP Status Code 200 and response code 501.

In case of connection issues with the wallet's server, the same retry method will be applied.

API Call Sample:

curl -i -X POST \
  http://integrator-gaming-platform.io/rest/v1/api/playerInformation \
  -H 'Content-Type: application/json' \
  -d '{
    "sessionToken": "0Ja8M7KvY",
    "clientVersion": "1.0.0"
  }'
Response
application/json
{ "code": "0", "description": "Success", "playerId": "3456", "playerName": "ninja", "currencyCode": "USD", "testPlayer": false }

Request Schema:

sessionTokenstringrequired

Login session token, provided by the Operator side. Used in all requests initiated by RubyPlay (the RGS) when invoking the Operator GP service.

Example: "0Ja8M7KvY"
clientVersionstring

Game Client version, provided by the our side (our Game Client).

Example: "1.0.0"

Response Schema:

codestring

Response code.

Example: "0"
descriptionstring

Short description of the response code.

Example: "Success"
playerIdstring

Unique player ID on the Operator side.

Example: "3456"
playerNamestring

Unique player nickname on the Operator side.

Example: "ninja"
currencyCodestring

Currency used by the current player.

Example: "USD"
testPlayerboolean

Test players are not included in the billing report.

Default false
Example: false