Postman is a great tool for getting started with our API and seeing how it all works. We have put together a step-by-step guide to getting started with Postman.
Retrieving the Hotel_ID and API key
Creating a Postman Environment
Downloading Postman
You will first need to download the Postman app:
To retrieve the Impala's Postman collection go to Import> Link and add the link to Impalal API collection
Retrieving the Hotel_ID and API key
Once this is done, you will need to make a note of your Hotel_ID and the API key, both can be found in your Impala management console:
API key:
Hotel ID:
Adding the API key
In the dropdown menu of the Postman collection click on 'Edit':
Under "Authorization" add the API token:
Adding the HOTEL ID
The final step is adding the Hotel ID. The example below shows the URL to retrieve all the bookings plans, replace the {{HOTEL_ID}} tag with your hotel ID, click 'Send' and this will return all of the current reservations.
Creating a Postman Environment
If you want to avoid manually adding the hotel ID and API key everytime you run a API call. You also have the option to set up an environment in Postman.
You will need to click on the Settings wheel on the top right and then on "Add" to add a new environment, you will have to add the following:
- hotelId:
this is your hotel ID - apiKey:
this is the API key - apiHost:
https://api.getimpala.com
Click on "Add" on the bottom right and your environment is successfully created! You will want to ensure that on the top right on the dropdown you now select your new environment.