Получение списка кампаний фриспинов

Общая информация

Тип запроса	URL
GET	<server-pixmove-games>/freespins/list

Метод позволяет получить актуальный список фриспин кампаний.

Как это работает

В реализации фриспинов используются две основные сущности - кампания фриспинов и фриспины. В рамках одной кампании фриспинов пользователю могут быть начислены только одни фриспины.

Кампания фриспинов - это общая промоакция, которую может создать партнер и по параметрам которой игрокам будут присвоены бесплатные вращения (фриспины).

Фриспины - это бесплатные вращения, которые будут начисляться игрокам при заходе в игру.

При заходе в игру система проверяет подходит ли игрок под параметры кампании фриспинов (нужная валюта/нужная игра/нужный игрок). Если проверка пройдена успешно, то игроку будут начислены фриспины.

Параметры

Запрос

Все параметры в этом запросе кроме partnerId - опциональные, если они передаются, то используются в фильтрации получаемых кампаний фриспинов.

Название	Тип		Описание
partnerId	bigint		Уникальный идентификатор партнера
hash	string		Подпись (sha256 от hash строки)
campaignExtId	string	optional	Уникальный идентификатор кампании фриспинов в системе клиента
currencies	array	optional	Валюты для которых будут выдаваться фриспины
gameIds	array	optional	Идентификаторы игр для которых будут выдаваться фриспины
playerIds	array	optional	Идентификаторы игроков для которых будут выдаваться фриспины
status	string	optional	Статус кампании фриспинов ("active", "completed", "canceled")
closed	boolean	optional	Флаг, определяющий, будут ли возвращаться только закрытые кампании фриспинов
startTimeFrom	string	optional	Время действия кампании фриспинов (старт с), в формате ISO 8601
startTimeTo	string	optional	Время действия кампании фриспинов (старт по), в формате ISO 8601
endTimeFrom	string	optional	Время действия кампании фриспинов (конец с), в формате ISO 8601
endTimeTo	string	optional	Время действия кампании фриспинов (конец по), в формате ISO 8601
limit	bigint	optional	Количество кампаний фриспинов, которое будет возвращено в ответе
offset	bigint	optional	Смещение, определяющее, с какой кампании фриспинов начнется возвращение
withFreespins	boolean	optional	Флаг, определяющий, будет ли в ответе содержаться информация о текущих фриспинах для кампаний

Hash строка

“freespins_list” + partnerId + apiKey

Ответ

Название	Тип	Описание
campaigns	array	Массив с кампаниями фриспинов

Пример

Запрос

{  
    partnerId: 1,
    campaignExtId: 1,
    currencies: ['USD', 'EUR'],
    gameIds: [1, 2, 3],
    playerIds: ['1', '2', '3'],
    status: 'active',
    closed: false,
    startTimeFrom: '2025-07-01T15:04:32.384Z',
    startTimeTo: '2025-07-07T15:04:32.384Z',
    endTimeFrom: '2025-07-01T15:04:32.384Z',
    endTimeTo: '2025-07-07T15:04:32.384Z',
    limit: 10,
    offset: 0,
    withFreespins: true,
    hash: '123' 
}

Ответ

{
    "status": "success",
    "data": {
        "campaigns": [
            {
                "id": 11,
                "extId": "22",
                "spinCount": 20,
                "betLevel": 8,
                "closed": false,
                "maxWin": null,
                "minWin": 0,
                "startTime": "2025-07-01T15:04:32.384Z",
                "endTime": "2025-08-25T15:05:16.592Z",
                "partnerId": 1,
                "Freespins": [
                    {
                        "id": 23,
                        "campaignId": 11,
                        "playerId": 164,
                        "gameId": 17,
                        "currencyId": 1,
                        "status": "active",
                        "currentSpins": 0,
                        "currentWin": 0,
                        "closed": false
                    }
                ]
            }
        ]
    },
    "serverTime": 1752245215266,
    "duration": 182
}