Skip to main content

Introduction

The SKChase API is a publicly available interface allowing developers to use SKChase data and build their own applications.

SignalR & Websocket architecture​

The API is based on the Web Socket architecture and SignalR is used as a library that makes it easier to establish Websocket connections.

The WebSocket API is an advanced technology that makes it possible to open a two-way interactive communication session between the user's browser and a server. With this API, we can send messages to a server and receive event-driven responses without having to poll the server for a reply.

For most applications, it is recommended to use SignalR over raw WebSockets. SignalR provides transport fallback for environments where WebSockets is not available. It also provides a basic remote procedure call app model.

Why SignalR?​

We are offering an interactive experience to visitors starting with vouchers listing, through adding / removing items in a basket, all the way to selecting delivery methods and completing a checkout, including making payments. Such a shopping session is long-lived and some information such as names, descriptions, prices and item availability might change.

We want to propagate the changes to visitors in a timely manner. Pushing updates to visitors also allows us to keep the basket up to date across many tabs the user might have open, regardless where they made a change.

We are making public the API we ourselves use on our voucher sites.
In the future, we might offer a restful HTTP API.

Functionalities​

These docs will help you connect and interact with the API.
You will find examples how to:

  • Browse vouchers;
  • Interact with the basket;
  • Access the checkout functionalities.