API Reference

Get Started with Postman API

Setting up


  1. Go to the Platform app applications UI to get the link to the API collection. Then, fork (or " import a copy" for Desktop Postman) the collection into a freshly created new Postman workspace (create this beforehand) by clicking the Run in Postman button:

( import a copy for Desktop Postman App is recommended by the person who most recently edited this)

We recommend forking this collection after creating your OAuth application so that your application keys get automatically exported to that collection. (Note that the REDIRECT_URI is not going to work with the web-version of the Postman App. Use the desktop-version of the Postman App.)

  1. Once you have forked/imported the collection, you’ll need to add a few Keys to your environment.


  1. We have already exported a new environment along with the collection. In the upper right, click the dropdown and select the ItscheckmateV2-ENV environment you just imported:


  1. In the Postman app, click on the collection folder and see the Authorization window. Go to the bottom of that window and hit Get New Access Token.

Subsequent to the first iteration of this document, we found that when using the desktop-version of the Postman App - you need to append `?grant_type=authorization_code&client_id={{CLIENT_ID}}` as Query Params to the Access Token URL. So that is what you will see in the Collection when you fork it. But you probably should be fine sending it only a Body Param when you implement it.


  1. Upon clicking, it will ask you to enter Checkmate Menu Management portal credentials. Once authorized, it will show Access Token in that window. Copy that Access Token and hit the Use Token button.


  1. Edit the Checkmate ENV file and add this Access Token.


  1. The next step is to Activate this Access Token. Click on the API Request activate_access_token and hit Send button, you will get a success message: “Location authorized successfully”


  1. Moving forward, for every request (Location/Menu/Order), you just need to add {{ACCESS_TOKEN}} ENV variable and it should show the results in response.

This must be done as Header and NOT a Query Param like so:

Hit Send button and see the response:


  1. Follow the same instructions above to get the Menu/Order endpoints working.