This provides an overview of the swiftpos Admin API, that is used to gain access to swiftpos Back Office data.
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.
Subjects ▼
What Is It? ▲ ▼
The swiftpos Admin API is a Cloud based API (Rest API) and is a rebrand of the formerly known swiftpos Cloud API. It is used to access swiftpos endpoints (paths) against which designated operations can be requested to access to swiftpos Sales, Member, Product, Voucher, etc information. Refer to SwiftPOS Admin API Endpoints for more information.
It makes use of the swiftpos Gateway Client Service to establish connectivity via the swiftpos Back Office API, to post/pull Member, Product, Sales and Voucher data directly from/to the swiftpos Back Office Database.
Why Is It Needed? ▲ ▼
It is used to gain access to swiftpos Sales, Member, Product and Voucher information, and is available to 3rd Party Application (3PA) integrators.
Increase Security - The swiftpos Back Office API replaces the Local WebAPI. The swiftpos Back Office API removes the risks and offers a more secure connection method. The connection is a HTTPS secure, VPN-less and encrypted connection, where data can be posted/pulled, including, Member, Product, Sales and Voucher information. swiftpos Back Office API requires a secure integrator key for each 3PA. The integrator key must be matched with on premise credentials and only then will an 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. 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 Admin API to the swiftpos Back Office API.
Endpoints (Paths) ▲ ▼
Refer to SwiftPOS Admin API Endpoints for more information.
How Is It Used? ▲ ▼
Similar to OrderAway and TouchMini, Venues can create multiple "API Locations" based on the existing Locations within the Venue.
Notes...
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 Admin API
To get started follow the steps outlined in Getting Started and once completed swiftpos Admin API will then be available for 3PA integrators to connect to a Venue's swiftpos solution.
Refer to How To Test swiftpos Admin API for more information.
End of article. ▲