Cloud
      Back to home
      1. swiftpos Help Guides
      2. How To
      3. Cloud

      Authenticate A Venue With swiftpos Cloud

      This outlines How To Authenticate A Venue With swiftpos Cloud in OrderAway and TouchMini v1/v2.

      Subjects      ▼

      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 recommended to first 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 recommended to configure 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 Venue's connection to the swiftpos Cloud Infrastructure.

      How Is It Done?      ▲ ▼

      A Clerk/Staff Member needs to be created in Back Office to ensure it can be used when Activating Locations.

      This Clerk will need to be assigned to a Clerk Security Group to which the appropriate Web API permissions can be granted.

      It will also need to be assigned to Clerk Group that has access to all Location Groups (Venues) requiring access to swiftpos Cloud, hence facilitating the successful operation of Cloud applications such as OrderAway, TouchMini v1/v2 and other 3rd Party Ordering systems.

      For this, it is recommended the following are configured:

      Security Group      ▲ ▼

      Configure a Clerk Security Group to which the appropriate Web API permissions can be granted. To do this, do as follows:

      1. Navigate to the Clerk Security Groups menu in Back Office.
      2. Add a new Security Group and name it appropriately. For example, SwiftPOS Web API.
      3. Ensure all the permissions listed after expanding the Web Api option listed under the Web permissions, in the Clerk Group Permissions section of the Security Group Full Edit screen.


      • 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 POS Clerks/Staff Members.

      Clerk Group      ▲ ▼

      Configure a Clerk Group to which the appropriate Venue Assignment can be granted to all Location Groups (Venues) that will have access to swiftpos Cloud. To do this, do as follows:

      • Navigate to the Clerk Groups menu.
      • Select the New button to add a new Clerk Group.
      • Name it appropriately. For example, Venues For Cloud Access.
      • Using the Venue Assignment button assign the new Group to the appropriate Location Groups (Venues).


      • Save the changes.


      Clerk      ▲ ▼

      Configure a Clerk to ensure it can be used when Activating Locations. It will then, also need to be assigned to the Security Group and Clerk Group created above. To do this, do as follows:

      Notes...



      The Clerk/Staff Member created here will be required to be entered each time a swiftpos Location is activated.

      • Navigate to the Clerk Records menu.
      • Select the New button to 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, SwiftPOS API Cloud Clerk.
      • 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.


      • Ensure a PIN is entered and associated with the new Clerk. Enter a 9-digit number.
      • Save the changes.

      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.

      End of article.      ▲