- swiftpos Help Guides
- API
- POS API
-
Installers / Links / Releases
-
API
-
Back Office
-
Back Office Cloud
-
Events
-
Events Portal
-
How To
-
KVS
-
Member Portal
-
Notify
-
Oolio Pay
-
OrderAway
-
POS Keys
-
Self Service Kiosk
-
Self Service POS
-
swiftpos
-
Touch
-
TouchMini
-
TouchMini v2
-
Troubleshooting
-
Venue Manager
-
Venue Hub
-
3rd Party Integrations
- Business Intelligence
- Cash Management
- eCommerce
- Exports / Imports
- Front Office Systems
- Fuel Systems
- Gaming
- General Ledger
- Gift Cards / Promotions / Vouchers
- Membership / Loyalty
- Middleware Applications
- Payment Integrators
- Product Level Blocking
- Reservations
- swiftpos
- Tab Management
- Time & Attendance
- Value Added Services
-
Uncategorized
How To
POS API with Touch
This outlines the How To articles for POS API.
How To? ▼
How To Configure The POS API Interface? ▲ ▼
What Is Required? ▲ ▼
- Ensure the Touch (SwiftPOS.Touch.exe) application has been started (at least once in the past) with the right click Run as Administrator option selected, on the Terminal that is designated as the Orders Terminal for the selected Location.
To confirm this has been the case, check that the POS.Gateway.Client.exe entry is visible in the Windows Task Manager and has a status of Running. To do this refer to the Confirm Resolution section for more information. If it is NOT visible, then refer to How To Run Touch As Administrator for more information.
How To Configure The POS API Interface? ▲ ▼
Once the What is Required? above has been completed, do as follows:
- Start Touch on the Terminal that is designated as the Orders Terminal for the selected Location.
- Then navigate to the Interface List menu option of the Terminal Settings menu.
- if POS API is NOT listed in the POS Interfaces screen, then
- Select the Add New option to open the Add New Interface screen.
- Select the Web Server option from the Interface Type drop-down list.
- Select OK.
- The POS API entry should now be listed in the POS Interfaces screen.
- Select the POS API entry and then select Edit to open the Web Server - POS API Settings screen.
- Ensure the Port field is set to 33300.
- Ensure the Return Receipt Text option is selected.
- Ensure the Max Width setting is configured for the best result. A width of 32 is recommended.
- Ensure the Return Receipt Image option is selected.
- Ensure the Open Port for All Users option is selected.
- Consider the selection of the Existing Order Validation option.
- If configuring a Master Orders terminal, it is recommended to ensure the Unattended Mode option is selected.
- Select OK to save any changes and close the Web Server - POS API Settings screen.
- Select Edit again to open the Web Server - POS API Settings screen.
- Confirm that the URLs field now lists entries. Refer to the example screenshot below.
- Select the SwiftPOS Services Monitor menu option from the from External Applications menu of the swiftpos Back Office main menu's Toolbar.
- When selected an icon is created in the system tray as seen below.
- Select the Show hidden icons up arrow in the system tray and right click the icon to open the SwiftPOS Services Monitor menu.
End of article ▲