This manual is being depreciated. Much of the information here is out of date.
The new Jomres Documentation, updated in 2022, can be found at Jomres.net/documentation.
Important : Jomres API endpoints are plugins for Jomres, therefore you will need a valid license for Jomres to install these plugins through the Jomres Plugin Manager > API features tab before you can communicate with them.
Note, this document is intended for developers.
API functionality allows remote systems to access your Jomres database through "API Clients".
You could think of these as sub-accounts of your main account, ones which can be given individual rights ( or permissions ). This allows third party systems to "talk" to the Jomres system without needing to write code that hooks into Jomres. It provides a platform agnostic framework, enabling diverse applications such as mobile apps or other websites to pull information from your database.
Any registered user of the website can create API Clients, however normal guest users will not have access to property related functionality.
The functionality uses the OAuth2 standard for giving Clients permission to access the system.
The methods list ( the things that the API can do ) is currently under development, as of Jomres 9.8. Once 9.8.0 is released, you can expect the number of methods to increase as we will be rolling these out as plugins which are complementary to the Core functionality.