Getting Started

This outlines the information and steps that are needed when wanting to make use of the swiftpos Admin API.

The content is targeted at Resellers and swiftpos Venue Administrators who have a sound knowledge of and experience with swiftpos. For further information or assistance, please contact your swiftpos Reseller or swiftpos Support.

---

Steps To Follow      ▼

• What Is It?
• What Is Required?
• Obtain an Integrator ID
• Configure Venue Manager
• Obtain An Authorisation Token
• To Be Considered
• How To Test Using Swagger (For Resellers Only)

---

What Is Required?      ▲ ▼

• Web Server - A Web server (for example, IIS) must be installed and running. Refer to Reseller Help – Web Server (IIS) Installation for more information.

• Registration - A Web API Location licence will be required for each Location within a Venue for which a 3PA is required access to using the swiftpos Admin API.

• SwiftPOS
  • v10.58+

• Server - Access to the swiftpos Back Office server and with the authority to start Back Office with the right click Run as the Administrator option selected.

• Back Office
  • Services - The following services need to be installed and running:
    • Connect
    • Gateway Client - This service needs to be installed and will only start when a cloud connectivity Location is Activated. Once activated, the Gateway Client service will be started. It facilitates the communication from the Venue’s swiftpos Back Office server to the swiftpos OrderAway Cloud Server. This will be an outbound secure amqp internet connection to the Cloud.
    • Sales Processing
    • Service Monitor
  • Clerks
    • Authentication to swiftpos at a Venue - Refer to How To Authentication To swiftpos At A Venue for more information.
    • Ensure the appropriate permissions are granted to the Clerk Security Group configured in the Security Groups menu option in Back Office, namely:
      • Web
        • Web Api (ensure this option is selected so that all it's sub options are selected).
  • Cloud Onboarding - The Venue hosting the swiftpos application will need to be Cloud Onboarded. Refer to How To Cloud Onboard A Venue for more information.
  • Cloud Connectivity
    • Locations - Venues will need to add each Location that is going to be making use of the swiftpos Admin API and then also ensure each of them is activated.
      • Activate - Each Location that is going to be making use of the swiftpos Admin API will need to be activated. Refer to How To Activate A swiftpos Location for more information. When activating a Location , ensure the Submit orders directly to POS terminal option is selected. This will ensure that for OrderAway and TouchMini the POS API is used. For 3PA integrator calls, the POS API is NOT used and instead calls are sent to Back Office.
      • NetPOS - The NetPOS tab must be configured when 3PA integrators want to make use of the following types of swiftpos Admin API calls:
        • Members
        • Orders - All Orders must have a Member assigned, including Orders placed by guest Members.
  • Products - For 3PA integrators to make Product calls using the swiftpos Admin API, Products must be assigned to a Family and it must be Web enabled.

• Touch
  • Also, consideration may need to be given to the Finalise Remote/Web Order options available within the  Orders tab in Table Tracking.
  • An Orders Master terminal must be enabled and ensure it has the Enabled option selected in the Orders tab.

---

To Be Considered      ▲ ▼

• URLs
• HTTP Header Change
• API Call Change

---

URLs      ▲ ▼

The URLs for the swiftpos Admin API are:

• For Test - https://api-test.swiftpos.com.au
• For Production - https://api.swiftpos.com.au

The URLs to test swiftpos Admin API using Swagger are:

• For Test - https://api-test.swiftpos.com.au/swagger/
• For Production - https://api.swiftpos.com.au/swagger/

Refer to How To Test swiftpos Admin API for more information.

---

Http Header Change      ▲ ▼

If previously the Local WebAPI was being used the the following will need to be considered:

• The HTTP Header Key name will need to be changed from ApiKey to AuthorizationToken.

---

API Call Change      ▲ ▼

An API call must now include the URL above. For example:

• A current API call using the local WebAPI may look something like this:
  http://127.0.0.1/WebAPI/api/Product

• Based on the above, the same call using the SwiftPOS Admin API will then look like this:
  https://api.swiftpos.com.au/api/Product

End of article.      ▲