TABLE OF CONTENTS
- Introduction
- Authentication Methods
- Customising Authentication Methods
Introduction
For guests to access the wireless network through a portal, they will need to go through one of the many authentication methods we have available. Authentication methods can be tailored to your needs by customising the prerequisite information that is required to log in. For example, you can ask for a guest's first name, last name and email address whilst also including custom guest fields such as shoe size or country of origin.
Authentication Methods
Authentication Method | Description |
Resident | Used for resident authentication. |
Voucher | Used for voucher code authentication. Displays a voucher input field for users to enter platform generated voucher codes. |
Self Registration: SMS | Used for SMS authentication. Guests will enter their mobile number and will receive a text that includes a code. The user will then enter this code into the portal page to log in. NB: Requires an external plugin and SMS gateway. |
Self Registration | Our most customisable authentication method. By default, self registration is a click and connected authentication and only requires the user to click the login button. Other fields can be added as part of the authentication process if you wish to capture the data to report on later. |
PMS | Use the venue's Property Management System (PMS) to authenticate guests based on their room details. NB: Connector plugin required |
Credit Card | Charge guests with any clearing house configured via plugin*. Use a voucher authentication option for recurring guests unless re-authentication has been enabled. *See plugins for more details. |
PayPal | Charge guests with your PayPal account via plugin*. Use a voucher authentication option for recurring guests unless re-authentication has been enabled. *See plugins for more details. |
Accor ALL | Third party loyalty authentication option. |
GHA Login | Third party loyalty authentication option. |
GHA Registration | Third party loyalty authentication registration option. |
Allow guests to authenticate using their social media account. | |
Allow guests to authenticate using their social media account. |
Adding Authentication Methods to the Portal
To learn how to add authentication methods to the portal, click here.
Customising Authentication Methods
Internal Authentication/Registration
Resident
Checkout the resident page for more details.
Voucher
Step | Description |
1 | Navigate to the portals page and add the voucher authentication option using the steps outlined here. |
2 | Select the voucher authentication option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named Voucher but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Required | At least one field is required for Voucher authentication. Best practice dictates that this be the username field. If you want added security, you can add a password field as well, however, your voucher codes must be setup to match. See the vouchers page for more information. To delete fields, click the delete icon at the far right of the row. |
Used to authenticate | Tick box | Required | Tick this box to ensure the platform checks the voucher codes are valid. If left unticked, any text can be entered to authenticate. |
Validation | Dropdown | Required | Click the dropdown to select one of the validation options. Validation ensures users enter the correct data before submission. Validation includes:
For voucher codes, as they could be any combination of numbers/letters, ensure you select not empty. |
Group | Tickbox | Optional | Tick this box to group fields next to each other in the portal instead of having them being stacked. |
+ More | Button | Optional | Click this text to add more fields to your authentication method. |
Button translation | Text | Optional | Enter text here to change the text that will appear on the authentication's Login button. By default, this will say Continue. |
Case-insensitive authentication | Tickbox | Optional | Tick this box to ensure voucher codes ignore the character case the user inputs. For example, if a code includes both uppercase and lowercase letters, the user can input the code in lowercase and still authenticate. |
Allow conference codes | Tickbox | Optional | Tick this box to allow codes generated within the conference tool to be used by the voucher authentication. This is only relevant if you have a conference tool licence. |
Delete | Button | N/A | Deletes the authentication method. |
Save | Button | N/A | Saves the authentication method. |
Voucher Example
Self Registration: SMS
SMS Registration has two components. First, there's the field to enter the users cell phone number. Once they have entered their cell phone number and submitted it they will recieve a text message containing their unique access code. The user will then enter their access code into a voucher field.
Step | Description |
1 | Navigate to the portals page and add the Self Registration:SMS authentication option using the steps outlined here. You should also add a Voucher authentication option to allow users to enter the login code they will recieve via text. |
2 | Select the Self Registration:SMS option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named Self Registration:SMS but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Required | By default, there are no fields created when first enabling SMS Authentication. A phone number field is required in order for the user to enter their phone number. Other fields can also be added, but aren't required. To delete fields, click the delete icon at the far right of the row. |
Validation | Dropdown | Required | Click the dropdown to select one of the validation options. Validation ensures users enter the correct data before submission. Validation includes:
Please check what format the phone number is needed in with your SMS provider. This will dictate the level of validation needed. |
Group | Tickbox | Optional | Tick this box to group fields next to each other in the portal instead of having them being stacked. |
+More | Button | Optional | Click this text to add more fields to your authentication method. By default, the SMS authentication does not have fields configured so users will need to add at least one via this method. |
Text Message | Text Field | Required | This is where you configure the message that will be sent to guests prior to authentication. Ensure you have entered the variable {username} if you want users to receive their login code via text message. |
Service tier | Dropdown | Required | Select the service tier you wish guests to use after Self Registration: SMS Authentication. For more on service tiers, click here. |
Button Translation | Text | Optional | Enter text here to change the text that will appear on the authentication's Login button. By default, this will say Continue. |
Delete | Button | Optional | Deletes the authentication method. |
Save | Save | Optional | Saves the authentication method. |
Self Registration: SMS Example
Self Registration: SMS Portal Example
Self Registration
Step | Description |
1 | Navigate to the portals page and add the Self Registration authentication option using the steps outlined here. |
2 | Select the Self Registration option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named Self registration but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Optional | Self registration is our most customisable authentication method. By default, there are no fields created when first enabling Self Registration authentication, however, you can add several required, or optional, fields to enhance your data gathering and security. You can also not add any fields to enable a simple click and connect portal. To delete fields, click the delete icon at the far right of the row. |
Validation | Dropdown | Optional | Click the dropdown to select one of the validation options. Validation ensures users enter the correct data before submission. Validation includes:
|
Group | Tickbox | Optional | Tick this box to group fields next to each other in the portal instead of having them being stacked. |
+More | Button | Optional | Click this text to add more fields to your authentication method. |
Service tier | Dropdown | Required | Select the service tier you wish guests to use after Self Registration. For more on service tiers, click here. |
Button translation | Text | Optional | Enter text here to change the text that will appear on the authentication's Login button. By default, this will say Continue. |
Delete | Button | N/A | Deletes the authentication method. |
Save | Button | N/A | Saves the authentication method. |
Self Registration (Click to Connect) Example
Self Registration (Email Login) Example
External Authentication/Billing
Property Management System (PMS)
Before continuing, ensure you have integrated your Property Management System (PMS) with the Platform.
Step | Description |
1 | Navigate to the portals page and add the PMS authentication option using the steps outlined here. |
2 | Select the newly added PMS option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named PMS but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Required | PMS authentication typically requires the surname used on the booking confirmation, and the room number the guest has been allocated, to allow guests to access the WiFi. If you have two, or more, hotels using the same property management system you can also add the room_prefix option to append a hidden prefix to your guest's authentication details which will map them to the correct property. See below for more details. To delete fields, click the delete icon at the far right of the row. |
Used to authenticate | Tickbox | Required | Tick this box to use the field in question to authenticate the guest. For example, the room number will be checked against the external PMS, if the room number entered matches - the guest will authenticate. |
Store data into | Dropdown | Required | If you wish to store data within the platform, use this dropdown to allocate a place to store the data. You can also create custom guest data fields if needed. For more info on custom data fields, click here. |
Validation | Dropdown | Required | Click the dropdown to select one of the validation options. Validation ensures users enter the correct data before submission. Validation includes:
|
Group | Tickbox | Optional | Tick this box to group fields next to each other in the portal instead of having them being stacked. |
+More | Button | Required | Click this text to add more fields to your authentication method. |
PMS Example
Multi Property PMS Setup
If you have two or more properties using the same property management system you can configure a prefix that will be used to ensure the guest is identified correctly.
Step | Description |
1 | Navigate to the portals page using the steps above. |
2 | Add the PMS Authentication method to the portal by clicking Add Content and selecting PMS Authentication. See above for more details. |
3 | Ensure you have added the field Room_Prefix to the guest fields. By default, the authentication method will have Room and Last Name already configured. Click +More and select Room_Prefix from the dropdown menu. |
4 | Ensure the Used to Authenticate tickbox is selected. |
4 | Click Save. The pop-up window will close. |
5 | Select the PMS Authentication method again from the content table to configure your property identifier. |
6 | Enter your unique property identifier into the Room_Prefix text box. This can be letters, numbers or both but is limited to two characters. There should be only one Room_Prefix per portal page. |
7 | Click Save to complete the configuration. |
Multi Property PMS Example
Tier Rules
Tier rules dictate which service tiers apply to the PMS. With the tier rules page, you can assign multiple service tiers to the PMS login to give your PMS Authenticated guests more choice.
To access the Tier Rules configuration, click +More within the Tier rules section of the pop-up.
Field | Field Type | Requirement | Description |
Name | Text | Required | Type into this field to give a name to your tier rule. This should be something recognisable. |
Service Tier | Text | N/A | Your previously configured service tiers will appear in the table column. To learn how to create a service tier, click here. |
Display | Tickbox | Optional | If ticked, the service tier will be displayed for the user to choose when logging in. This is important if you want your PMS guests to have access to more than one service tier. |
Free of charge | Tickbox | Optional | If ticked, the service tier in question will be free of any associated charges for your PMS guests. |
Automatically apply tier | Tickbox | Optional | If ticked, the service tier will be automatically applied. This only works when one service tier is selected. |
Always show tier page for existing accounts | Tickbox | Optional | If ticked, the service tier selection page will always be displayed when guests log in. If unticked, previously logged in guests will not see the tier selection page and will continue on the tier they originally selected. |
Condition | Tickbox | One required | The Tier Rules condition dictates when a tier rule will trigger. There are three options to choose from:
|
Tier Rules Example
Credit Card
Before continuing, ensure you have a credit card plugin enabled. This option will not work without a credit card plugin enabled. For more information, click here. A voucher form is also required for returning guests unless re-authentication is enabled.
Steps | Description |
1 | Navigate to the portals page and add the Credit Card authentication option using the steps outlined here. |
2 | Select the Credit Card option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named Credit card but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Optional | No fields are required for credit card authentication, however, you can add some if you wish to gather guest data. For example, feel free to put an email input to collect user email addresses. |
Validation | Dropdown | Optional | As fields are not required for credit card, validation is down to whether you choose to add any fields. |
Group | Tickbox | Optional | If using multiple fields, tick this box to group fields next to each other in the portal instead of having them being stacked. |
+More | Text Button | Optional | Click this text to add more fields to your authentication method. |
Servicer Tier | Text | N/A | This column shows currently active service tiers associated with the site. |
Enable (Service Tier) | Tickbox | Required | Tick the box associated with the service tier you want applied to the credit card authentication. As it is credit card authentication, ensure the service tier used has a price associated with it. |
Button translation | Text input | Optional | Enter text here to change the text that will appear on the authentication's Login button. By default, this will say Continue. |
Delete | Button | N/A | Delete authentication method. |
Save | Save | N/A | Save authentication method. |
Credit Card Example
Credit Card Portal Example
PayPal
Before continuing, ensure you have a PayPal plugin enabled. This option will not work without a PayPal plugin enabled. For more information, click here. A voucher form is also required for returning guests unless re-authentication is enabled.
Steps | Description |
1 | Navigate to the portals page and add the PayPal authentication option using the steps outlined here. |
2 | Select the PayPal option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text | Optional | If you wish, you can change the name of the authentication option. By default, it is named PayPal but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | Optional | No fields are required for PayPal authentication, however, you can add some if you wish to gather guest data. For example, feel free to put an email input to collect user email addresses. |
Validation | Dropdown | Optional | As fields are not required for PayPal, validation is down to whether you choose to add any fields. |
Group | Tickbox | Optional | If using multiple fields, tick this box to group fields next to each other in the portal instead of having them being stacked. |
+More | Text button | Optional | Click this text to add more fields to your authentication method. |
Service tier | Text | N/A | This column shows currently active service tiers associated with the site. |
Enable (Service Tier) | Tickbox | Required | Tick the box associated with the service tier you want applied to the credit card authentication. As it is PayPal authentication, ensure the service tier used has a price associated with it. |
Button translation | Text input | Optional | Enter text here to change the text that will appear on the authentication's Login button. By default, this will say Continue. |
Delete | Button | N/A | Delete authentication method. |
Save | Button | N/A | Save authentication method. |
PayPal Example
PayPal Portal Example
Accor ALL
For more information on Accor ALL configuration, click here.
GHA Login
For more information on GHA configuration, click here.
GHA Registration
For more information on GHA configuration, click here.
Social Media
Steps | Description |
1 | Navigate to the portals page and add the Facebook authentication option using the steps outlined here. |
2 | Select the Facebook option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text Input | Optional | If you wish, you can change the name of the authentication option. By default, it is named Facebook but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | N/A | No data is available to gather from Social Media accounts. |
Store data into | Dropdown | Optional | Select where you wish to store data gathered from the users social media profile. Whilst there are database entries for some of the data available to gather, you may need to create more. To see how to do this, click here. |
Validation | Dropdown | Optional | Validation is not needed for social media authentication as the information is coming straight from their profile and will have already been validated by the social media method. |
+More | Text Button | Optional | Click this text to add more fields to your authentication method. |
Service Tier | Dropdown | Required | Select the service tier you wish guests to use after Social Media authentication. For more on service tiers, click here. |
Delete | Button | N/A | Delete authentication method. |
Save | Button | N/A | Save authentication method. |
Facebook Example
Steps | Description |
1 | Navigate to the portals page and add the Twitter authentication option using the steps outlined here. |
2 | Select the Twitter option from the login page content table. |
3 | A pop-up will appear. See details below |
Field | Field Type | Requirement | Description |
Name | Text Input | Optional | If you wish, you can change the name of the authentication option. By default, it is named Twitter but can be changed if required. |
Enable | Tickbox | Required | Tick this box to enable the authentication method. If unticked, it will not display on the portal. |
Field | Dropdown | N/A | No data is available to gather from Social Media accounts. |
Store data into | Dropdown | Optional | Select where you wish to store data gathered from the users social media profile. Whilst there are database entries for some of the data available to gather, you may need to create more. To see how to do this, click here. |
Validation | Dropdown | Optional | Validation is not needed for social media authentication as the information is coming straight from their profile and will have already been validated by the social media method. |
+More | Text Button | Optional | Click this text to add more fields to your authentication method. |
Service Tier | Dropdown | Required | Select the service tier you wish guests to use after Social Media authentication. For more on service tiers, click here. |
Delete | Button | N/A | Delete authentication method. |
Save | Button | N/A | Save authentication method. |
Twitter Example
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article