Plugins

Created by chris.joinson@airangel.com, Modified on Mon, 16 May, 2022 at 1:22 PM by chris.joinson@airangel.com

TABLE OF CONTENTS

Introduction
Location
Adding a Plugin
Available Modules
Configuration Details

Introduction

The platform can integrate with various third party products and services such as marketing CRMs, payment platforms, loyalty programmes and property management systems. Each plugin will be unique in terms of what is required for setup and may require input from both the platform provider and the 3rd party provider.

Location

Step	Description
1	Log into the platform.
2	Enter the settings page by opening the account menu at the top right of the screen and selecting Settings.
3	Find and select Plugins.

Adding a Plugin

Step	Description
1	Navigate to the plugin page using the steps above.
2	Click Add Plugin at the top right of the page.
3	A pop-up will appear. Create a name for the plugin you're enabling.
4	Use the dropdown to select an appropriate plugin module. The various modules and configuration details are listed below.

Available Modules

Module	Description
SMS	Configure a 3rd party SMS gateway to enable SMS sending from the platform.
Credit Card	Configure a 3rd party payment platform to enable credit card payments.
PayPal	Configure a PayPal plugin to enable PayPal or Braintree payments.
Facebook like	Request a Facebook 'Like' when a user authenticates using Facebook login.
Twitter follow	Request a Twitter 'Follow' when a user authenticates using Twitter login.
RSS Feed	Pull an RSS feed into your portal page.
Weather API	Connect a compatible Weather API to display Weather information on the portal page.
Connector	Configure a connector to enable setup of various other products and services.
Content Filter	Enable content filtering on your network.
WLAN Filtering	Enable WLAN filtering on your network. WiFi filtering that blocks access to websites that do not conform to standard security protocols and websites that hide their true identity behind a proxy server or the 'who is' privacy feature.
Facebook Login	No longer in use, Facebook login is available to configure during portal configuration.
Linkedin Login	No longer in use.
VK Login	No longer in use.
Twitter Login	No longer in use, Twitter login is available to configure during portal configuration.
Google Login	No longer in use.
External RADIUS	Configure an external RADIUS server.
Kickbox	3rd party email verification software.
GHA Login	3rd party loyalty software. Allows guests to authenticate using their Loyalty membership login.
External resource	Configure an external resource to appear in an iFrame or as an item in the side menu.
802.1x	Enable to configure 802.1x authentication.
Network authentication	Used in conjunction with the Connector and 802.1x plugin to enable Network Authentication.
Pulse	3rd party customer satisfaction software.
Accor ALL	3rd party loyalty software. Allows guests to authenticate using their Loyalty membership login.

Configuration Details

SMS Plugin

SMS - Custom Gateway

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
SMS gateway	Dropdown	Required - Choose Custom	Select the type of SMS gateway that will be used. For a custom SMS gateway, select custom.
URL	Text input	Required	The URL for your SMS Gateway. Note that the phone number and messages are configured using curly braces in the URL string, and will be replaced with the correct text by the plugin. The URL format will be supplied by the SMS provider.
Success response regex check	Text input	Required	A regular expression that allows the platform to identify a successful API request. This will vary by SMS gateway and will need confirming by the SMS provider.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin to identify which sites are using the plugin. Some plugins do not require a site tag such as the Accor ALL.

SMS - DataPort

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
SMS Gateway	Dropdown	Required - Choose DataPort	Select the type of SMS gateway that will be used. Select DataPort.
Username	Text input	Required	Enter your username.
Password	Text input	Required	Enter your password.
Originator	Text input	Required	Enter the originator.
Account Number	Text input	Required	Enter your account number
Short Number	Text input	Required	Enter your short number.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

SMS - SMSAPI

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
SMS Gateway	Dropdown	Required - Choose SMSAPI	Select the type of SMS gateway that will be used. Select SMSAPI.
Legacy mode	Tickbox	Optional	Legacy mode can be used to support older hardware and configuration types.
Access Token	Text input	Required	Enter your access token.
From	Text input	Optional	The name of the sender. By default, the name is set to "Test"
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Credit Card

Ogone

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Clearing House	Dropdown	Required - Choose Ogone	Select the type clearing house that will be used. Select Ogone. An account will need to be created with Ogone.
API username	Text input	Required	Enter the API username associated with your Ogone account.
API password	Text input	Required	Enter the API password associated with your Ogone account.
Merchant	Text input	Required	Enter the merchant/merchant ID associated with your Ogone account.
Test	Tick box	Optional	Tick this box to enable test mode.
SHA-in/out pass	Text input	Required	Enter your SHA-in/out passphrase. SHA-in = The key that is used to verify the input parameters of a transaction. SHA-out = The key used to verify the returned parameters, once a transaction is completed.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Sage pay

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Clearing House	Dropdown	Required - Choose Sage	Select the type clearing house that will be used. Select Sage.
Vendor	Text input	Required	Enter your Vendor here.
Test	Tickbox	Optional	Tick this box to enable test mode.
Password	Text input	Required	Enter your password here.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

PayPal

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Email/Merchant ID	Text input	Required	Enter the email address of the merchant or the merchant ID.
Test	Tickbox	Optional	Tick this box to enable test mode.
Merchant Account ID	Text input	Optional	Enter the merchant account ID. This is only required for Braintree accounts where a Braintree account has sub accounts e.g. A company has multiple sites with different set up in pricing.
Identity token/Public key	Text input	Required	Enter the identity token or the public key.
Signature/Private key	Text input	Required	Enter the signature or the private key.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Facebook Like

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
URL to Like	Text input	Required	Enter the URL of the Facebook account you'd like users to 'Like'.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Twitter Follow

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Account to follow	Text input	Required	Enter the URL of the Twitter account you'd like users to follow.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

RSS Feed

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
URL	Text input	Required	Enter the URL of the RSS feed you wish to display.
Amount of items to display	Text input	Required	Enter the amount of items you wish to display in the URL feed. The more there are, the longer the field will be.
Display	Dropdown	Required	Configure where you wish the RSS feed to be displayed.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Weather API

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Display	Dropdown	Required	Configure where you'd like Weather information to be displayed.
Temperature Scale	Dropdown	Required	Choose the units you'd like your temperature to be displayed in.
Location Type	Dropdown	Required	Configure the location you'd like to show weather updates for. You can type in the city or use Latitude & Longitude co-ordinates.
Use Custom Icons	Tickbox	Optional	Click here to use custom icons for your weather display.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Connector

For information on the Connector, visit Connector setup.

Content Filter

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Email	Text input	Required	Enter the email address associated with the content filter.
Password	Text input	Required	Enter the password associated with the content filter.
API Key	Text input	Required	Enter the API key associated with the content filter.
Organisation ID	Text input	Required	Enter the Organisation ID associated with the content filter.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

WLAN Filtering

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
API Key	Text input	Required	Enter the API key associated with the WLAN filtering.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

External Radius

For External Radius configuration, visit the external radius setup.

Kickbox

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
API Key	Text input	Required	Enter the API key associated with your Kickbox account.
Timeout	Text input	Required	Maximum time, in milliseconds, for the API to complete a verification request
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
API Token	Text input	Required	Enter the GHA API token associated with your property.
GHA Enrolment Code	Text input	Required	Enter your GHA enrolment code.
GHA Notification Email	Text input	Required	Enter the email address you wish to send notification emails to. This is usually an email address associated with the property and should not be customer facing.
GHA test mode	Tickbox	Optional	Click to enter test mode.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

External Resource

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
URL	Text input	Required	Enter the URL/path to the external resource.
Behaviour	Dropdown	Required	Use the dropdown to configure how the external resource will be seen. You can choose from: Open in tab - An icon will be available in the left hand side navigation menu. When clicked, a new browser tab will open taking you to the external resouce. iFrame - Content will show within an iFrame on the dashboard.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

802.1x

For more information on 802.1x, visit here.

Network Authentication

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
URL	Text input	Required	Enter the URL associated with Network Authentication.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Pulse

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Template ID	Text input	Required	Enter the template ID associated with the property's Pulse account. This is usually a string of letters and numbers.
Room	Dropdown	Required	Select the Room data field. This will be used to collate your reports and identify the guest.
Name	Dropdown	Required	Select the First name or last name data field. This will be used to collate your reports and identify the guest.
Email	Dropdown	Required	Select the Email data field. This will be used to collate your reports and identify the guest.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.

Accor ALL

Field	Field Type	Requirement	Description
Name	Text input	Required	The name of the plugin. The name can be changed.
Accor ALL API Key	Text input	Required	Enter the Accor ALL API Key here.
Accor ALL Client ID	Text input	Required	Enter the Accor ALL Client ID.
Accor ALL API Domain	Text input	Required	Enter the URL for the Accor ALL API domain
Accor ALL Customer Domain	Text input	Required	Enter the URL for the Accor ALL customer domain
Accor ALL API Secret	Text input	Required	Enter the Accor ALL API secret
Accor ALL Base URL	Text input	Required	Enter the Accor ALL base URL.
Accor ALL Redirect Path	Text input	Required	Enter the Accor ALL redirect path.
Delete	Button	N/A	Delete the plugin.
Save	Button	N/A	Save the plugin.
Add Tag	Button	Required	Add a tag to the plugin. The site tags of the sites making use of the plugin must be added here.