Взаимодействие с SailPlay API построено на HTTPS-запросах. Все параметры передаются в формате GET или POST-запросов. В ответ возвращается данные в формате JSON
Внимание
Для повышения уровня безопасности передаваемых данных, мы рекомендуем использоваться HTTPS-запросы к API-методам. При этом все запросы должны быть адресованы строго к домену "sailplay.ru".
В дальнейшем будем использовать следующие понятия:
-
Приложение – любая система, обращающаяся к Sailplay для получения или создания данных. Например, сайт, мобильное приложение или POS-терминал.
-
Транзакция – любое действие, связанное с начислением/списание бонусных баллов у пользователя, с использованием API (в т.ч. покупки, выдача подарков, начисление бонусных баллов).
-
Токен – уникальный идентификатор сессии. Используется для подписи запросов приложения, отправляющихся в систему SailPlay.
-
Идентификатор департамента – уникальный идентификатор магазина в Sailplay. Используется для подписи запросов приложения, отправляющихся в систему SailPlay. Также необходим для связки с некоторыми типами данных – заказы, клиенты, баллы.
-
PIN – числовой код, используется в некоторых запросах к API SailPlay (например в авторизации). Целевое назначение – разделение частей системы партнера, для построения дальнейшей аналитики.
-
Номер заказа – главный идентификатор заказа для синхронизации заказов в вашей системе и в Sailplay. Sailplay не накладывает никаких ограничений на формат данного параметра.
-
Идентификатор клиента – идентификатор, по которому происходит сопоставление клиентов в вашей системе и в Sailplay.