Guides

Find our guides here and learn more about the GameSystem. If there's something missing, feel free to contact us to ask any questions and we'll try to update or add to the guides.

Postman


When it's time to start developing a client that consumes the GameSystem REST APIs you'll need to write a small amount of code to make things work (constructing the REST request, dealing with security and authorization headers, etc.).

If you just want to get going immediately, use Postman to make requests to the GameSystem APIs with no programming necessary.

Collection


The GameSystem API Postman Collection is a group of pre-made Postman requests and contains two folders - one for each API. There is also another folder for the GameSystem Identity Provider which contains requests for retrieving an access token.

Clicking the button above will give you the option to open the collection in the Postman app or on with Postman on the web.

A copy of the Collection will then be imported into your Postman workspace. Feel free to do whatever you like with the collection as it is just a copy. If you want a fresh copy you can always import it again by following the above steps.

Environment


A Postman Environment is a set of key-value pairs that stores variables. When importing the above Collection, a Game System Environment will also be imported. This environment holds variables that are referred to in the pre-request script as well as the URL of the request. Always make sure that the correct environment is selected as in the picture below.

Making requests to the Client API requests a Player specific API token. This token is retrieved from an Admin request to the players endpoint. In order to make a request to the Client API on behalf of a Player follow these steps:

  1. Click the Environments "Eye" icon in the top right hand corner
  2. Click "Edit" next to the GameSystem environment
  3. Replace the values for TENANT with the right-most part of the apps URL listed in the overview page
  4. Click "Update"
  5. Edit the Authorization settings for the Game Server folder and add your Oauth credentials.
  6. Proceed to make any API request

Making Requests


To make a request simply click on an item in the collection and hit "Send". If it's a POST request then you'll most likely need to click on the "Body" tab and change the pre-populated values in the existing body.