Tokeet V2 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
- ICAL Sync
- 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
Introduction
Tokeet V2 (PAPI)
Tokeet is a full-fledged property management system (PMS), well-equipped to manage all of your reservations and properties. Send invoices with one click and accept credit card payments directly. Tokeet centralizes all guest communications, allows team coordination, tracks expenses, runs reports, and much more. Tokeet makes it easy to stay on top of your business whether you have one rental or one thousand.
Portal
Add Listings
Add Calendar / Availability
Add Reservations
Cancel Reservations
Booking Engine:
API Integration
Credentials Required
- Client ID
- Client Secret
- Redirect URL
- Authorization Code
Access token & Client secret required for getting response of all requests.
Client ID & Client secret will be the same for all clients. Both required things alreadyprovided by tokeet.
For getting Authorization code need to hit this URL in browsers window.
https://papi.tokeet.com/dialog/?response_type=&scope=&client_id=&redirect_uri
Endpoints
API Doc: https://docs.tokeet.io/reference/introduction
- Get Access Token
- GET Listings https://papi.tokeet.com/v1/rental
- GET Single Listing
https://papi.tokeet.com/v1/rental/{pkey}
- GET Availability
https://papi.tokeet.com/v1/rental/{pkey}/availability
- GET Prices
https://papi.tokeet.com/v1/rate/{rental_id}
- GET Images
https://papi.tokeet.com/v1/image
Missing data
- No create reservation endpoint although a Booking URL for booking on portal
- No cancel reservation endpoint
- No cleaning Fee
Manual sync options
- All Data sync
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.
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.
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\tokeet\assets\js\tokeet.js
- plugin\tokeet\tokeet.php
Gateways
Stripe
Changes regarding stripe to Tokeet reservation are in the following files.
- theme\homey-child\template-parts\instance-booking\nightly.php
- plugin\tokeet\tokeet.php
- plugin\tokeet\assets\js\tokeet.js
- plugin\tokeet\classes\class-stripe.php
Homey theme settings to enable / disable Stripe gateway
Code
Child Theme
Path: theme\homey-child
API Plugin
Path: plugin\tokeet-V2