Tokeet 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.

1 - 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.

2 - Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations.

Booking Engine:

3 -  API Integration 

Credentials Required

1. Client ID
2. Client Secret
3. Redirect URL
4. Authorization Code

Access token & Client secret required for getting response of all requests.

Client ID & Client Secret will be provided by tokeet support team.

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

1. Get Access Token

1. GET Listings https://papi.tokeet.com/v1/rental

1. GET Single Listing 

https://papi.tokeet.com/v1/rental/{pkey}

1. GET Availability

https://papi.tokeet.com/v1/rental/{pkey}/availability

1. GET Prices

https://papi.tokeet.com/v1/rate/{rental_id}

1. GET Images

https://papi.tokeet.com/v1/image

Missing data

1. No create reservation endpoint although a Booking URL for booking on portal
2. No cancel reservation endpoint
3. No cleaning Fee

Manual sync options 

1. All Data sync 

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

1. ICAL sync

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. 

4 - 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. 

5 - 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\tokeet\assets\js\tokeet.js
4. plugin\tokeet\tokeet.php
   

6 - Gateways

Stripe 

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

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

Homey theme settings to enable / disable Stripe gateway

7 - Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\tokeet-V2