This outlines the information and steps that are needed when wanting to make use of the SwiftPOS API.
The content and related topics are targeted at Resellers and 3rd Party Application (3PA) integrators 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)
- Related Topics
What Is Required?
- Web Server – A Web server (for example, IIS) must be installed and running. Refer to the Reseller Help – Web Server (IIS) Installation for more information.
- Registration – A Web API Location licence will be requiring for each Location within a Venue for which a 3PA is required access to, via the SwiftPOS 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).
- Web
- Cloud Onboarding – The Venue hosting the SwiftPOS application will need to be Cloud Onboarded. Refer to How To Onboard A Venue With SwiftPOS Cloud for more information.
- Cloud Connectivity
- Locations - Venues will need to add each Location that is going to be making use of the SwiftPOS API and then also ensure each of them is activated.
- Activate – Each Location that is going to be making use of the SwiftPOS 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 API calls:
- Members
- Orders – All Orders must have a Member assigned, including Orders placed by guest Members.
The above can be done by selecting the Edit button in the NetPOS tab for the selected Location in the Cloud Connectivity screen.
- Locations - Venues will need to add each Location that is going to be making use of the SwiftPOS API and then also ensure each of them is activated.
- Products – For 3PA integrators to make Product calls using the SwiftPOS API, Products must be assigned to a Family and it must be Web enabled.
- Services – The following services need to be installed and running:
- 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
URL
The URL for the SwiftPOS API is https://api.swiftpos.com.au.
Refer to How To Test SwiftPOS API for more information.
The URL for Swagger is https://api.swiftpos.com.au/swagger/
Notes …
The URL to test SwiftPOS API in a test environment is https://api-test.swiftpos.com.au/swagger/. Refer to How To Test SwiftPOS 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 API will then look like this:
https://api.swiftpos.com.au/api/Product
This completes GETTING STARTED for SwiftPOS API.