DocumentationEnvironments

Environments

Qerko provides two main environments for integration: Sandbox (for safe testing) and Production (for real customers). This page will help you set up both, so you can develop and test your integration with confidence.


Sandbox Environment

The sandbox is your playground. Here, you can safely build and test your integration with simulated payments—no risk, no real money involved.

Getting Started

  1. Install the Qerko App Download the app for iOS or Android.

    iOSAndroid
    Qerko-AppStoreQerko-GgStore
  2. Switch to Sandbox Mode By default, the app is in production mode. To switch, scan a sandbox QR code or log out and log in with qerko-toggle-test as your email address. A red TEST mark will appear at the top of the screen, indicating that the app is now in sandbox mode.

    ProductionSandbox
    Qerko-prodQerko-sand
  3. Register and Add a Test Card Once in sandbox mode, register your account and add a test card. Payments are simulated, so feel free to pay for anything.

    ČSOB (CZ)

    Card numberExpirationCVC
    4000 0070 0001 000612/30600

    More ČSOB test cards

    PayU (SK, DE, AT)

    Contact techsupport@qerko.com to enable the correct payment gateway for you. The default payment gateway is ČSOB.

    Card numberExpirationCVC
    5150 0300 9035 018612/29123

    More PayU test cards

    Adyen (HU)

    Contact techsupport@qerko.com to enable the correct payment gateway for you. The default payment gateway is ČSOB.

    Card numberExpirationCVC
    4111 1111 4555 114203/30737

    More Adyen test cards

  4. Set Up Your Sandbox Restaurant Go to Restaurant Admin and create a test restaurant. After registration, you will be taken to the restaurant creation form. Preferably, use your POS name as the restaurant name. You can create any number of restaurants. Before testing payments, let our tech support know so they can enable the necessary payment gateways for your test restaurants.

  5. Create an API Key Each restaurant gets its own API key. You’ll need this for authorization. There is a link API keys admin in the left column (accessible by the icon in the top left corner on a smartphone). This key is used at the “restaurant level,” so each restaurant has its own key. It must be editable in the POS by restaurant, or by POS vendor.

  6. Set a Pos-Id Use any non-empty string in the sandbox. All POS systems are required to use a Pos-Id. This is a unique identifier for every vendor.

  7. You’re Ready! You can now test payments and integration features.

    • You have set up the app on your smartphone.
    • You have added a credit card to the app.
    • You have an API key for POS authorization.

Tools for Testing

  • Demo POS: Try out our Demo POS to see how things work. This is a simple POS that serves as our testing environment. Feel free to use it to see how things work. DEMO2 uses WebSocket and the current API v2.
  • API Tester: Send raw requests and see responses. https://sandbox.qerko.com/api/v2/pos/ This is a simple tool that sends requests to the API. Use it to test raw requests and responses.
  • API Key Checker: Use this function to verify your API key format.
    function verifyApiKey(apiKey: string): boolean {
        const KEY_LENGTH = 29;
        if (apiKey.length != KEY_LENGTH) {
            return false;
        }
     
        const HASH_LENGTH = 4;
        let base = apiKey.substr(0, apiKey.length - HASH_LENGTH);
        let hash = apiKey.substr(apiKey.length - HASH_LENGTH, HASH_LENGTH);
     
        return hex(sha1(base)).toLowerCase().startsWith(hash);
    }

Production Environment

When you’re ready to go live:

  1. Switch your API URL to https://qerko.com/api/v2/pos/
  2. Use your production Pos-Id (assigned by Qerko support). Start using the production Pos-Id, which will be assigned to you by tech support at techsupport@qerko.com. The process of assigning a production Pos-Id mostly consists of testing the documented functionalities in the sandbox environment—having it tested on your own and ready for our testing will be greatly appreciated. We recommend hardcoding the Pos-Id into your POS or distributing the value with the POS. It is not supposed to be user-configurable.

Need help? If you get stuck or have questions, email us at techsupport@qerko.com—we’re here for you!