Getting Started

est. reading time: 2 minutes.

Our POS API helps you to handle zmyle giftcards of all kinds. With this API, there is mainly two actions that you can perform on giftcards: you can sell them or you can redeem them. Both of those actions are performed by a retailer, so in order to use this API you need API keys from a retailer / stores account.

Your API Keys

You can find your API keys in your retailer backoffice on the team-management page. If there is no API keys yet you can simply create new ones.

In this guide we are demonstrating requests against our sandbox environment. To make the same requests to our live systems you can simply switch the hostname.

Test your API Keys

Once you have your API keys you can go ahead and make your first request. All you need is one of our giftcards; either a QR code, or short-code or the full giftcard ID. All the info and actions that this API offers are centered around giftcards. So go ahead and make your first request for retrieving a giftcard object (see Discover a Giftcard):

curl \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --user '<your-api-key>:<your-api-secret>' \
  https://posapi.zmyledemo.de/service/v1.1/gift_cards/find?query=test

You should be retrieving a json response with info on the giftcard.

Next: Setup Considerations

Before we can start using our giftcards we should go over some fundamental things that you might want to consider.