This provides an overview of the SwiftPOS API available to 3rd Party Application (3PA) integrators in SwiftPOS. SwiftPOS API brings the 3PA’s connection infrastructure in line with SwiftPOS OrderAway and TouchMini. The development means consistent setup and configuration for all three applications.
Subjects
What Is It?
The SwiftPOS API is a cloud-based API that replaces the current Local Web API. SwiftPOS API uses SwiftPOS Connect to access a Venue’s SwiftPOS solution via the Gateway Service.
It has been developed specifically for all 3rd Party Application (3PA) integrators to connect without using the existing Local Web API. The SwiftPOS API enables instant calls to be made between 3PAs by posting/retrieving up-to-date data to/from a Venue’s SwiftPOS solution.
Why Is It Needed?
Increase Security – The SwiftPOS API has been introduced, to replace the existing Local WebAPI. As the name suggest, the Local WebAPI was local to the venue’s network, requiring port forwarding to be set up, which left venues networks exposed to outside risks. The SwiftPOS API removes this risk as ports are no longer required. The connection is a HTTPS secure, VPN-less and encrypted connection, where data can be called through, including, Products, Sales, and Member details. SwiftPOS API requires a secure integrator key for each 3PA. The integrator key must be matched with on premise credentials and only then will a authorisation token be generated for that 3PA.
Consistency and Simplicity – This feature development brings 3PA’s connection infrastructure in line with SwiftPOS OrderAway and TouchMini. The development means further consistency when setting up all three applications. Venues will no longer need to setup port forwarding via routers to connect the Local Web API through to 3PAs, as noted above, 3PAs will now have the same configuration setting as OrderAway and TouchMini, simplifying the onboarding process.
Available In?
SwiftPOS v10.58+
Who Can Use It?
From an operational standpoint and 3PA connection, nothing changes. Once the Getting Started process has been completed, existing 3PAs will instantly connect through via the SwiftPOS API.
How Is It Used?
Similar to OrderAway and TouchMini, Venues can create multiple “API Locations” based on the existing Locations within the Venue.
NOTE : A Web API Location licence will be required for each Location within a Venue for which a 3PA is requiring access to, via the SwiftPOS API.
In order for 3PAs to make API calls to a SwiftPOS Venue they will need to establish a connection by requesting an authorisation token via the SwiftPOS API.
To get started follow the steps outlined in Getting Started and once completed SwiftPOS API will then be available for 3PA integrators to connect to a Venue’s SwiftPOS solution.
Refer to How To Test SwiftPOS API for more information.
This completes ABOUT for SwiftPOS API.