This outlines how to authenticate a Venue with the SwiftPOS Cloud.
Subjects
- What Is It?
- Why Is It Needed?
- Who Can Do It?
- When Can It Be Done?
- What Is Required?
- How Is It Done?
- Related Topics
What is it?
Authentication to SwiftPOS at a Venue is a set of permissions/credentials which can be used by the SwiftPOS Cloud Infrastructure to retrieve, create and update data at a Venue. This is facilitated by using the SwiftPOS Clerks feature.
Why Is It Needed?
It’s needed to ensure that the SwiftPOS system at a Venue is secure, only allowing access to systems/persons that have been granted access.
Who Can Do It?
A person that has:
- Back Office Clerk Security access to the following Clerk menus:
- Clerk Records.
- Clerk Groups.
- Clerk Security Groups.
- A Clerk ID/PIN which grants access to all Location Groups (Venues) in a SwiftPOS database for a Venue.
When Can It Be Done?
- The Clerk and associated groups should be setup/configured the FIRST time a Venue are needing to connect their instance of SwiftPOS to the SwiftPOS Cloud Infrastructure. The one set of credentials can be used multiple times from that point onwards.
What Is Required?
- It’s suggested to check whether a Clerk and Groups have already been created for the SwiftPOS Cloud Infrastructure to use so there aren’t multiple records to maintain.
- It’s suggested to have a separate Clerk and Groups for the SwiftPOS Cloud Infrastructure to use for that differ from 3rd party systems that may be directly accessing the Back Office API (SwiftAPI).
- This allows for easy de-activation of these 3rd parties in-future which won’t impact the SwiftPOS Cloud Infrastructure connecting.
How Is It Done?
Clerks
A Web API specific Clerk needs to be created specifically to ensure that it has the authority to access the Web API functions required by the Web based applications such as OrderAway, TouchMini and other 3rd Party Ordering systems that use the SwiftPOS Cloud. Also, the same Clerk can then be used when Activating Locations. For this it is recommended the following are configured:
Security Group
It is recommended that a specific Clerk Security Group be created, to which the appropriate Web API permissions can be granted.
- Navigate to the SwiftPOS Clerks > Clerk Security Groups menu.
- Add a new Security Group and name it appropriately. For example, API Access SwiftPOS Cloud.
- Ensure that under the Web permissions, listed in the Clerk Group Permissions, the Web Api and all the permissions under it are selected. Identify an appropriate Clerk Security Group for the API user to be assigned too which can be granted all ‘Web Api’ permissions within.
- Save the changes.
Notes …
Consideration must be given as to where the API Access Clerk Security Group – SwiftPOS Cloud Group is located in the grid of the Clerk Security Groups screen. If it remains at the bottom of the grid, this may mean that any new Clerk Records created will default to it. It is therefore recommended that it is Moved Up in the grid to a position ABOVE the Security Group for Cashiers/POS Operators.
Clerk Group
It is recommended that a specific Clerk Group be created, so that it can be assigned to the appropriate Location Groups (Venues) using the Venue Assignment button. to which the API User can be assigned. It can then be granted the appropriate Web API permissions.
- Navigate to the SwiftPOS Clerks > Clerk Groups menu.
- Add a new Clerk Group and name it appropriately. For example, API Access SwiftPOS Cloud.
- Using the Venue Assignment button assign the new Group to the appropriate Location Groups (Venues).
- Save the changes.
Clerk
It is recommended that a specific Clerk be created, so that it can be used by the Web API to authenticate and can also be assigned to the Security Group and Clerk Group created above. The Clerk created here will be required to be entered each time a SwiftPOS Location is activated.
- Navigate to the SwiftPOS Clerks > Clerk Records menu.
- Add a new Clerk
- Consider assigning it a Clerk ID, so its easily identifiable in reports etc. For example, 888000001 (9-digit number).
- Name it appropriately. For example, API Access SwiftPOS Cloud.
- Ensure the POS option in the header section of the screen is NOT selected, as this Clerk only needs access to the SwiftPOS Back Office API (SwiftAPI).
- Ensure it is assigned to the Security Group and Clerk Group created above.
- Save the changes.
- Ensure a PIN is entered and associated with the new Clerk. Enter a 9-digit number.
Notes …
Store the PIN that was entered securely, as it will be required each time the Location is re-activated. Locations need to be re-activated any time changes are made to their settings and thus require these to be updated to the Cloud Infrastructure.
This completes HOW TO AUTHENTICATE A VENUE WITH SWIFTPOS CLOUD for SwiftPOS.