An API (Application programming interface) is "an interface or communication protocol between a client and a server".
In simple words, it's a way to extract data from a program and transfer it to another.
The Rentman (public) API allows you to build your own integrations with other programs. In this article, we provide a general overview of the Rentman API and give instructions on how to access it.
Get your API token
To use the Rentman API you must generate an API token. The API Token is personalized and used for authentication - just like a password. Please don't share this token with anyone (see our good practices for API security). Please note that the API token is now available for 10 years instead of 5. This change applies only to newly created tokens. After 10 years, you need to regenerate it.
To generate your token:
- Go to settings Configuration > Account > Integrations.
- If deactivated, click Connect in the 'API' field.
- Click Show token.
You can now use this token to build your API integrations. If you want to create a new token, click on Regenerate token. The old token will be invalidated.
Rentman Public API documentation
Read our Rentman API Documentation for all the information about authentication, headers, querying and limitations of our public API. Here you will also find all the codes necessary to the different calls.
Good practices for API security
API tokens give access to your Rentman account and you should protect them the same way you protect your password. Here are some common good practices for your API security:
- Don't expose the token to the public (like in screenshots or videos). Note: blurring your data isn't always enough. It's best to use "cut" functions in your graphics program to remove the data completely.
- If you have to share a token, generate a new one after to invalidate the old one.
- Never email the API token, because it would give access to your account's data if hackers would manage to break into your email account.
- The access to each call is determined by the role of the user who generated the API token.
API Consultations
If you are working on a custom integration with an in-house (or externally hired) developer our technical support specialist can assist them with questions that they may have about our API documentation. We will not assist in the actual programming/building of integrations, but we may be able to advise on other matters via this link.