Hi there and welcome to the Homeflow API documentation.
Homeflow provides developers with everything they need to build exceptional property based websites. Within this documentation we hope you will find all the information you need to get your agency or portal theme up and running.
Before you get stuck in and coding - please read our best practices section which will help both us and you when working on our platform.
As alluded to above, we’re making the assumption that you’re familiar with HTML, CSS etc. You will also need a basic working knowledge of Git and Liquid, though both are relatively simple to pick up as you go along.
Before we get started, there are three areas of the Homeflow API to be aware of as they will be mentioned throughout this documentation:
1) The Agency/Portal Admin
You can consider The Agency and Portal Admin as the repository of all the information related to an agency or portal (essentially a CMS) - think properties, pages, content, images and more. Hestia (The Greek Goddess of the Heart) allows the querying of this information at lightning fast speeds. Finally Ctesius (The Greek God of Property) is our frontend application that is powered by Hestia. It includes an event management system, supports advanced property searching, user profiling and will support and augment the theme you will build.
We will explore all of the technologies mentioned above in much more detail later in the guide. In the meantime you can head straight over to the section you require using the menu on the right.