Zeevou 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
Zeevou API
Zeevou is an easy-to-use online platform that automates hospitality management - from marketing, to bookings, to operation. It’s also a global community that helps you grows your hospitality business through cutting-edge automation, industry-leading training, and world-class support.
2. Portal
Add Listings
Add Calendar / Availability
Add Reservations
Cancel Reservations
For Client ID & Client Secret need to contact with Zeevou support.
3. API Integration
Credentials Required
- Client ID
- Client Secret
Client ID and Client secret are required for getting response of all requests.
Endpoints
API Doc: https://sandbox.zeevou.com/apis/docs
https://sandbox.zeevou.com/apis/docs?ui=re_doc
- GET Listings
https://hub.zeevou.com/apis/unit_types
- GET Single Listing
https://hub.zeevou.com/apis/unit_types/{id}
https://hub.zeevou.com/apis/properties/{id}
- GET Prices
https://hub.zeevou.com/apis/rates?&rate_plan
- GET Availability
https://hub.zeevou.com/apis/unit_type_availabilities
- Create Reservation
https://hub.zeevou.com/apis/group_bookings
Missing data
- No cancel reservation endpoint
- Images upload manually
Manual sync options
- All Data sync
- Single listing sync (Go single listing edit page)
Auto Sync Settings
- Plugin Setting page (Go to Listings > Settings)
- View existing auto schedules
- Can enable/Disable each auto sync by clicking checkbox under Action Column.
4.Website Settings
Plugin Settings
- Plugin Setting page (Go to Listings > Settings)
- Enter required API credentials
- Override options
- You can enable / disable override settings for API data.
- Can view and enable/disable Auto Syncs.
5. Customization
Auto Registration
Changes for auto registrations module are in following files.
- homey-child\template-parts\boostly-modal-register.php
- homey-child\template-parts\instance-booking\nightly.php
- plugin\zeevou\assets\js\zeevou.js
- plugin\zeevou\zeevou.php
6. Gateways
Stripe
Changes regarding stripe to Zeevou reservation are in the following files.
- theme\homey-child\template-parts\instance-booking\nightly.php
- plugin\zeevou\zeevou.php
- plugin\zeevou\assets\js\zeevou.js
- plugin\zeevou\classes\class-stripe.php
Homey theme settings to enable / disable Stripe gateway
7. Code
Child Theme
Path: theme\homey-child
API Plugin
Path: plugin\zeevou