Introduction

Environment

Set up your development environment using this guide.

Connection

Create the connection. You have three options—choose the one that fits you best:

• WebSocket – great for POS systems running on hardware on-site behind a NAT, like a classic program on a PC in the restaurant.
• Long-Polling – for similar situations as WebSocket, but if you can’t use WebSockets for any reason.
• Webhooks – perfect for cloud-based POS systems. Qerko sends webhooks to your cloud and expects a webhook response in return.

First method

Once your connection to Qerko is ready, you can start building! Begin with getTableList(). You can test it by loading the QR codes pairing page, which calls getTableList() every time it loads.

See QR codes pairing flow for details.

Pair QR codes

When you see your tables in Qerko’s Restaurant Admin, pair some QR codes to them.

Scan QR code

After pairing, scan a QR code using the Qerko mobile app (make sure you have it installed on your phone). See development setup for more info.

What’s on the table?

When you scan the QR code, Qerko will call getTableContents(). Continue with that method.

Payment

Once you see Bill(s) in the Qerko app, you’re ready for payments! Implement getBill(…), paymentStart(…), paymentProcessed(…), and paymentClosed(…).

See payment flow for details.

🎉 Congratulations!

You’ve completed the payment flow. If you want to take your integration further, you can move on to Orders. We’re cheering you on!