API Documentation

Player information

v1.0.0

This method retrieves player information

  • Path: /info
  • Request Method: POST
  • Content-Type: application/json; charset=utf-8
  • Headers: X-Art-Client-ID, X-Art-Client-TS, X-Art-Client-Signature

Request

ParameterTypeDescription
user_idstringPlayer ID on operator side
session_tokenstringToken generated by provider for current game session
currencystring [currency enum]Game currency. (currency code)

Response

ParameterTypeDescription
codeinteger [enum]Response code
messagestringResponse any logical message
dataobjectonly needed when code 200
user_idstringID of player on operator side
usernamestringName of player
balancelongCurrent balance of player in specified currency.
currencystring [currency enum]Currency of player
is_bonus_balanceoptionalbooleanIndicator if balance is bonus related. If value is false, aren't sent.

Important!

Each request sent to the API requires validation using specific security headers. For details on implementing this, refer to Securing API Requests.

Possible codes

  • 200 - Success
  • 401 - User token is invalid
  • 403 - User token is expired
  • 413 - Invalid Client-Signature
  • 500 - Internal error

If code is 200 - operator should always return parameter data with information; HTTP status code should always be 200