Skip to main content

General concepts

Interaction with the SailPlay API is based on HTTPS requests. All parameters are passed in the format of GET or POST requests

warning

Attention

To increase the security of transmitted data, we recommend using HTTPS requests to API methods. In this case, all requests must be addressed strictly to the "sailplay.net" domain.

In the future, we will use the following concepts:

  • Application – any system that accesses Sailplay to receive or create data. For example, a website, a mobile application or a POS terminal.

  • Transaction – any action related to the accrual/debiting of bonus points from a user using the API (including purchases, issuing gifts, accruing bonus points).

  • Token – a unique session identifier. It is used to sign application requests sent to the SailPlay system.

  • Department ID – a unique store identifier in Sailplay. It is used to sign application requests sent to the SailPlay system. It is also necessary for linking with some types of data - orders, clients, points.

  • PIN – a numeric code used in some requests to the SailPlay API (for example, in authorization). The purpose is to separate parts of the partner's system for further analytics.

  • Order number – the main order identifier for synchronizing orders in your system and in Sailplay. Sailplay does not impose any restrictions on the format of this parameter.

  • Client ID – identifier used to match clients in your system and in Sailplay.