WizBang OneTap Appropo API

Loyalty and Sales import connects to a central server for multi-store (ROSS) or direct to the store POS database for a single store.

Setup

POS PC

  1. Setup IIS
  2. Download Appropo bundle and extract into C:\Appropo
  3. Edit C:\Appropo\publish\appsettings.json and set the Database connection string and any OneTap Ids, add an API Key, don’t reuse the example one. Settings
  4. Install the .NET Core Hosting Bundle
  5. Create the IIS site
  6. In IIS Manager, open the server’s node in the Connections panel. Right-click the Sites folder. Select Add Website from the contextual menu.
  7. Provide a Site name (appropo-api) and set the Physical path to C:\Appropo\publish. Provide the Binding configuration (Port: 81) and create the website by selecting OK.
  8. From Applications Pools, select the sites pool and Edit Application Pool, set .NET CLR version to No Managed Code
  9. From Application Pool, Advanced settings, Change ‘Idle Time-out’ to 0
  10. Restart Site
  11. Open web browser to http://localhost:81 and check the output to see if everything is configured correctly
  12. Open a port on the Router and forward to this computers IP and port 81

Appropo Settings

The OneTap API needs to be setup and internet accessible. Enter the IP and Port of this server to the OneTap Integration, as well as the username and password

http://123.12.34.123:5000

Use the test button to check that we can connect

Loyalty

For loyalty account creation, add the account type id. This corresponds to the account type setup in OneTap and we’ll make new accounts using this.

Note: Bulk pre-allocation of accounts is required for multi-site ROSS setups

Barcodes

The easiest barcode for scanning is CODE128, by default the card number is encoded in the barcode.

Sentinel characters can be added around the card number eg. %<CARDNO>?

Account Pre-allocation

By pre-allocating a batch of accounts in OneTap, you can set an initial loyalty balance and have it available to a customer immediately after they sign up.

Preallocation needs to be done in OneTap and then the account range needs to be added to the integration settings in Appropo.

1000 accounts is a good place to start, for example an arbitrary range of 80000 to 81000

We’ll notify you when we’re reaching the end of the currently allocated batch

Sales Reporting

With the API setup, you can turn on sales importing in the Sales tab of the OneTap integration.

We’ll pull in sales periodically throughout the day, and use these for reporting.

Online Ordering

All the items you wish to be order-able need to be added to Appropo and each item and modifiers corresponding item/modifier id needs to be added to the appropriate items as a PLU

Note: Master Ids (MASIDS) need to be enabled for multi-site ROSS setups

There is an online checker in the menu which will show items and modifiers that are not setup fully.

Import Item

Storefront -> Store Settings -> Store -> Recieving Orders

Store Settings

API needs to be added to each store and made internet accessible

In the store setting for online ordering.

  • Select OneTap API as the ordering provider
  • Set the store API IP and port i.e http://123.123.123.123:456

Use the test button to check that we can connect

API Settings

Name Default Note
LoginId 1  
StaffId   You must set this
TerminalId   You must set this
MasterIds false false for Single Store or ROSS HQ, true for ROSS store
OnlineTenderLineTypeId 25  
CreditTenderLineTypeId 9  
CreditNoSaleTypeId   No Sale Type with FIXEDNSTYPEID = 2
RedeemCreditTenderLineTypeId 8  
RedeemCreditNoSaleTypeId   No Sale Type with FIXEDNSTYPEID = 3
ExpireCreditTenderLineTypeId 27  
ExpireCreditNoSaleTypeId   No Sale Type with FIXEDNSTYPEID = 8
PointsNoSaleTypeId   No Sale Type with FIXEDNSTYPEID = 7
RedeemPointsTenderLineTypeId 20  
ExpirePointsNoSaleTypeId   No Sale Type with FIXEDNSTYPEID = 8
CreditTolerance 0  
Loyalty1Tolerance 0  
Loyalty2Tolerance 0  
EnableTabSummary false Prints summary to reciept printer for unpaid online orders
EnableInvoice true Prints invoice to reciept printer for paid online orders
ClosePaidTabs true Close paid tabs
TestIgnoreDuplicates false Testing only

Ready to get started? Get in touch.

Contact