While Citrus Lime provides a complete end-to-end system, there are times when our customers want to use part of our system, and integrate it with their existing solution. For this, we provide the Cloud POS API.

The Cloud POS API implements Rate Limiting. This means that each user is limited to only make one request per second. The API will return with a HTTP status code of 429 if more requests have been made.

We've created both a VB and C# example project, which shows how to connect and interact with our API. A solution containing both the example projects can be downloaded to view the example code
Note: if the button fails to trigger the download you will need to right click on the download button, copy the link and then paste it into an incognito window.

Each Cloud POS license comes with a demo group. If you are integrating the Cloud POS API into your own product, we recommend that during development you create an API key for this demo group. This means you won't have any impact on live data; but you will need to make sure that your production code uses a different API key for your live group.

If you have any suggestions on how we can improve the Cloud POS API, you can provide them through our feedback page.