Hostfully API Documentation

Instructions:

• Document will have portal, plugin settings, each, and everything to setup
• The basic setup instructions for each PMS, any settings to amend in the portal, what is pulled, what can be changed, any maintenance, etc.
• In a word format and tom can then create it on site as a docs
• We might need to use screenshots as well

Index:

• Introduction
• Portal 

• Add Listings 
• Add Calendar / Availability
• Add Reservations
• Cancel Reservations

• API Integration

• Credentials Required 
• Endpoints 
  • All listings 
  • Single listing 
  • Reservations (Create/Cancel) 
  • Prices (Extra guest fee, daily price, Taxes, Discounts)
  • Availability (Min stay, Available)
• Missing Endpoints
• Manual sync all or single listing
• Auto Sync settings

• Website Settings

• Plugin Settings 
  • Overriding 
  • Cronjobs (Enable/Disable)

• Customization 

• Auto Registration 
  • Path of files for custom code.

• Gateways

• Stripe

• Options on theme settings
• Path of files for custom code.

• Code

• Child Theme.
• API Plugin.

1. Introduction 

Hostfully API

Hostfully Property Management Platform is a cloud-based solution designed to help small to large vacation rental businesses manage reservations across multiple channels. Key features include payment processing, instant messaging, team collaboration, upselling, analytics, and reporting.

2. Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations

API Key can be acquired by following these things:-

3. API Integration 

Credentials Required

1. API Key
2. Agency Uid 

API Key is required to GET response for all requests.

For live clients credentials working just need to change sandbox base URL from pluginwith this live one.

1. Sandbox URL

https://sandbox-api.hostfully.com/v2 /

1. Live URL  

https://api/hostfully.com/v2/

Endpoints

API Doc: https://dev.hostfully.com/v2.0/reference

1. Get Agencies 

https://sandbox-api.hostfully.com/v2/agencies

https://sandbox-api.hostfully.com/v2/agencies/uid

1. GET Listings https://sandbox-api.hostfully.com/v2/properties?limit=20&offset=0

1. GET Single Listing 

https://sandbox-api.hostfully.com/v2/properties/uid

1. GET Property Description

https://sandbox-api.hostfully.com/v2/propertydescriptions/:uid

1. GET Photos

https://sandbox-api.hostfully.com/v2/photos/:uid

1. GET Amenities

https://sandbox-api.hostfully.com/v2/amenities/uid

1. GET Prices & Availability

https://sandbox-api.hostfully.com/v2/pricingperiods/uid

4. Booking Widget

For live booking changes need to change this sandbox URL with live doc URL

Missing data

1. No create reservation endpoint
2. No cancel reservation endpoint

Manual sync options 

1. All Data sync 

1. Single listing sync (Go single listing edit page)

Auto Sync Settings

1. Plugin Setting page (Go to Listings > Settings)
2. View existing auto schedules 
3. Can enable/Disable each auto sync by clicking checkbox under Action Column. 

5. Website Settings

Plugin Settings

1. Plugin Setting page (Go to Listings > Settings)
2. Enter required API credentials 

1. Override options
2. You can enable / disable override settings for API data.

1. Can view and enable/disable Auto Syncs. 

6. Customization

Auto Registration

Changes for auto registrations module are in following files. 

1. homey-child\template-parts\boostly-modal-register.php
2. homey-child\template-parts\instance-booking\nightly.php
3. plugin\hostfully\assets\js\hostfully.js
4. plugin\hostfully\hostfully.php

7. Gateways

Stripe 

Changes regarding stripe to Hostfully reservation are in the following files.

1. theme\homey-child\template-parts\instance-booking\nightly.php
2. plugin\hostfully\hostfully.php
3. plugin\hostfully\assets\js\hostfully.js
4. plugin\hostfully\classes\class-stripe.php

Homey theme settings to enable / disable Stripe gateway

8. Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\hostfully