circle
1. Overview and Basic Information
notes
2. Testing Environment Setup
2.1 API flowchart
2.2 General Steps
Summary
2.2.1 Obtain the test environment token
2.2.2 Authentication & Authorization
2.2.3 Get the Full List of Countries
2.2.4 Get the Full List of Cities
2.3 Integration Based on Listing Plan
2.3.1 List listing plan
List Listing Plan Overview
Step 1 – Create a 'List' Property
step 2 - Add a Room to the Property
step 3 - Add Tenancy Information
step 4 - Add Images to the Property
step 5 - Add Facilities to the Property
step 6 - Provide Your Webhook URL
step 7 - Publish the Property
step 8 - Receive Webhook Notifications
step 9 - Get Leads List
2.3.2 Book listing Plan
Book Listing Plan Overview
Step 1 – Create a 'Book' Property
step 2 - Add a Room to the Property
step 3 - Add Tenancy Information
step 4 - Add Images to the Property
step 5 - Add Facilities to the Property
Step 6 – Bind Universities to the Property
Step 7 – Add Documentation to the Property
Step 8 – Set Up Payment Plans
Step 9 – Set Up Deposits
Step 10 – Set Up Order Fee
Step 11 – Set Up Installments
Step 12 – Set up Payouts / Payment Methods
Step 13 – Provide Your Webhook URL
Step 14 – Publish the Property
Step 15 – Receive Webhook Notifications
step 16 - Get Leads List
Step 17 – Confirm / reject order
2.3.3 Connect
Connect Listing Plan Overview
Step 1 – Create a 'Connect' Property
step 2 - Add a Room to the Property
step 3 - Add Tenancy Information
step 4 - Add Images to the Property
step 5 - Add Facilities to the Property
Step 6 – Bind Universities to the Property
Step 7 – Add Documentation to the Property
Step 8 – Set Up Payment Plans
Step 9 – Set Up Deposits
Step 10 – Set Up Order Fee
Step 11 – Set Up Installments
Step 12 – Set up Payouts / Payment Methods
Step 13 – Provide Your Webhook URL
Step 14 – Publish the Property
Step 15 – Receive Webhook Notifications
step 16 - Get Leads List
notes
3. Production Environment Setup
3.1 Apply for an API token on production
notes
4. Open API Reference
4.1 Object Structure
circle
5. PMS Integration Process
menu
search
Search
Enable dark mode
Enable light mode
to navigate
to select
to close
cancel
Home
2. Testing Environment Setup
2.3 Integration Based on Listing Plan
On this page
Table of Contents
article
2.3 Integration Based on Listing Plan
article
folder
2.3.1 List listing plan
article
folder
2.3.2 Book listing Plan
article
folder
2.3.3 Connect