Welcome to Homeloc’s api documentation!

Welcome to the Homeloc API documentation :) Here you will learn how to import data from our servers and ultimately take bookings using our stock control.

Note that our API is private, and you will need a login and a password to be able to access it. Ask your Homeloc contact for one if you haven’t already.

Our read APIs rely on Django Rest Framework. Thus you should be able to explore the API with your browser by just going to our APIs url. This might come in handy :)

The public Github repository for this documentation can be found here. Do not hesitate to report issues in this documentation there.

• Full funnel example
  • A word on URLs
  • Context
  • Importing rental data
  • Checking the availability in real time
  • Getting a definitive price
  • Registering the booking on Homeloc’s platform
  • Cancellation of the booking
• Test server
  • URL
• Authentication
• How to handle API responses
  • Response Format
  • Pagination
• Rental API
  • URL
  • Editorial content fields
  • Booking information fields
  • Other fields
• Real time availability check
  • URL
  • Expected fields
  • Response
  • Examples
• Real time price check
  • URL
  • Expected fields
  • Response
  • Examples
• Booking creation
  • URL
  • Expected fields
  • Response
  • Examples
• Booking cancellation
  • URL
  • Expected fields
  • Response
  • Examples