Get a Player

Returns a player by their username.

All parameters in the request can be sent in the querystring or posted. Make all requests to the following URL:

https://auth.construct.net/getplayer.json

Authenticating The Request

No authentication is required for this request type.

gameID guid Required: The ID of the game you are querying
username string Required: The username of the player you are querying.
secret string: Optionally pass an API key if you have set your game to require API keys for all auth get requests.

Unsuccessful responses always return 4xx HTTP status codes.

{
  "success":false,
  "errorMessage":"gameID is required parameter.",
  "shouldRetry":false
}

success bool: If the request was successful or not. For request failures, this will always be false.
errorMessage string: An short message explaining why the request was denied.
This should probably not be shown to clients.
shouldRetry bool: If true, this means the request is valid but it couldn't be processed at this current time - usually due to rate limits.
If this value returns as true, it's recommended to wait a few seconds then re-attempt the request. When re-attempting requests, make sure you regenerate the timestamp and hash parameters if no secret is being used.

Successful responses always return the HTTP 200 status code.

{
  "success": true,
  "player": { ... }
}

success bool: If the request was successful or not. For request successes, this will always be true.
player playerobject: The returned player object for your request.