Super Control 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 

SuperControl API

SuperControl provides intelligent booking and management software, channel manager and ongoing expert guidance to help self-catering businesses thrive.

2. Portal 

Add Listings

Add Calendar / Availability

Add Reservations

Cancel Reservations

SC-Token can be acquired by contacting with Super Control support.

Account ID can be acquired from here:-

Widget Calendar Key

For showing calendar for all listings you need to add calendar key in homey-child theme which can be acquired by following these screenshots. This key will be different for each website.

You need to add this calendar-key in this file of homey-child theme.

theme/homey-child/single-listing/booking/sidebar-booking-module.php

3. API Integration 

Credentials Required

1. Account ID
2. API SC-Token

SC-Token is required for getting response of all requests.

Endpoints

API Doc: https://secure.supercontrol.co.uk/page/apidocumentation/properties

https://secure.supercontrol.co.uk/page/apidocumentation/olb

GET Listings 

https://api.supercontrol.co.uk/v3/properties/index

1. https://api.supercontrol.co.uk/v3/properties/ContentIndex/id

1. GET Single Listing 

https://api.supercontrol.co.uk/v3/properties/listing/listingId

https://api.supercontrol.co.uk/v3/properties/ConfigurationIndex/id

1. GET Availability

https://api.supercontrol.co.uk/v3/properties/AvailabilityIndex/1

1. GET Prices

https://api.supercontrol.co.uk/v3/properties/PricesIndex/1

1. Create Reservation 

https://api.supercontrol.co.uk/v3/olb

Missing data

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

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\super-control\assets\js\super-control.js
4. plugin\super-control\super-control.ph

6. Gateways

Stripe 

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

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

Homey theme settings to enable / disable Stripe gateway

7. Code

Child Theme

Path: theme\homey-child

API Plugin

Path: plugin\super-control