7.36 Guide – How to work with API?
API needed to bring applications together in order to perform a designed function built around sharing data and executing pre-defined processes. It allows developers to build new programmatic interactions between the various applications people and businesses use on a daily basis. In this article we will share on how to work with the RentSyst API.
1. Go to the Postman page and get API:
API Documentation (Updates closed on September 2023)
API Documentation (Latest API, available from October 2023)
API link also available on main rentsyst website in the website footer.
2. Take a look at the list of all the necessary data transfer methods. For all of them except the authorization request, a Token is mandatory.
3. To authorize and receive a Token, you will need to enter client_id and client_secret and put these credentials into your code or inside the postman test environment. Now you may wonder – where to get this data? Check the next step and find the answer.
4. Follow your RentSyst account and reach the Settings page. Go inside the “Integrations & Agents” tab and create a new Agent. Press button Add new agent:
In the pop-up window – fill in the necessary data.
The most important section in this window is Connect type (select only API connection type), add Agent name, email and your website domain. After everything is filled, press Add new agent button.
5. Congratulations – you created a new Agent! Now click on the Agent frame to go inside and find credentials.
In the pop-up window you will see Agent profile settings – scroll down and below you will find generated client_id and client_secret. Now you get credentials!
(Pay attention – this screen is just a test sample and these keys are not valid).
6. Now to authorize and receive a Token, paste your key data into your code or inside the postman test environment. Awesome, you got it – now you can work with RentSyst API and build your booking.
If you have any questions left about API connection, please feel free contact our Customer Success Department: