REST API
All API calls return a string Result value as the first field in the returned data. Possible values are:
Result | Description |
SUCCESS | ​ |
CALL_ALREADY_IN_PROCESS | ​ |
WAITING_FOR_GAME | ​ |
GAME_ALREADY_STARTED | ​ |
GAME_HAS_ENDED | ​ |
INVALID_LOGIN_OR_PASSWORD | ​ |
INVALID_PLAYER_KEY | ​ |
BOT_IS_SUSPENDED | ​ |
BOT_IS_INACTIVE | ​ |
INSUFFICIENT_BALANCE | ​ |
NOT_YOUR_MOVE | ​ |
INVALID_MOVE | ​ |
Value | Description |
STARTING_SOON | Game will start shortly |
RUNNING | Game is in progress |
WON | Game is over and this client won |
WON_BY_TIMEOUT | This client won by the other player timing out |
LOST | This client lost |
LOST_BY_TIMEOUT | This client lost by timing out |
DRAWN | The game ended in a draw |
All API access is over HTTPS, and accessed through:
​https://19y3lnjoy9.execute-api.eu-west-2.amazonaws.com​
All data is sent and received as JSON. ​
postGet List Of Game Styles
{"Result": "See List Of Result Values","GameStyles": [{"GameStyleId": 99,"GameType": 99,"Stake": 99,"Prize": 99,"GameTypeSpecificInfo":}],"Balance": 99}
postOffer Game
{"Result": "See List Of Result Values","GameState": [GameType specific JSON describing the current state of the game],"PlayerKey": "key",GameId: 99}​
postCancel Game Offer
{"Result": "See List Of Result Values","GameState": [GameType specific JSON describing the current state of the game],}
postPoll For Game State
{"Result": "See List Of Result Values","GameState": [GameType specific JSON describing the current state of the game],}
postMake Move
{"Result": "See List Of Result Values","GameState": [GameType specific JSON describing the current state of the game],}
You can try out the API using the handy Postman app for Chrome - use this link:
​https://www.getpostman.com/apps​
We have created a complete GUI app in Python that uses the REST API to play games on our site. This provides a great example of how each REST API call should be implemented.
You can find out more details about this and how to download it on our Test harness using the REST API page.