ОБЩАЯ ИНФОРМАЦИЯ

Данный API предоставляет доступ к некоторой информации о картах Game-Keeper и позволяет проводить ряд операций. Этот API является ПО промежуточного слоя, не следует предоставлять к нему доступ конечному пользователю (владельцу карты), т.к. в API отсутствуют возможности аутентификации и авторизации.

...

data - запрашиваемые данные, зависят от запроса, 
errors - список ошибок, возникших при выполнении запроса. 
Успешность выполнения запроса определяется отсутствием ошибок.

ПОДДЕРЖИВАЕМЫЕ ТИПЫ ЗАПРОСОВ

Информация о карте

Запрос

GET 
/api2/cards
? [n=<номер карты>]

...

• card - номер карты;
• bonus - сумма бонусов;
• bonusI- сумма неактивных бонусов;
• points - сумма игровых очков;
• moneyCash - сумма наличных денег;
• moneyBCard - сумма, оплаченная банковской картой;
• moneyCS - сумма, оплаченная безналичным платежом;
• tickets - сумма тикетов;
• moneyAccum - общая внесенная сумма;
• state - ID статуса карты;
• fullName -
• activation - время активации карты.

История операций

Запрос

GET 
/api2/cards/history
? [n=<номер карты>]

...

    },     {       "date": "2023-02-17T16:32:32.927+03:00",
      "name": "Открытие счета \"Активация карты\"",
      "activityName": "Открытие счета",
      "productName": "Активация карты",
      "value": 0,
      "u1code": "",
      "u2code": "",
      "card": 12047

    }

   ]

}

Информация о владельце карты

Запрос

GET 
/api2/cards/owner?n=номер карты

Ответ

Информация о персональных данных гостя.

...

• card - номер карты;
• first_name - имя владельца карты;
• last_name - фамилия владельца карты;
• middle_name - отчество владельца карты;
• birthday - день рождения;
• gender - пол (1 - жен; 0 - муж);
• phone - номер телефона;
• email - электронная почта;
• address - адрес;
• passport - паспортные данные;
• mailing_consent - согласие на рассылку;
• personalized - стоит галочка персонализированный;
• in_bonus_program - находится в системе бонусов.

Альтернативный код (внешний идентификатор)

Информация о совладельцах

Запрос

GET 
/api2/cards/coowners?n=номер карты

...

Персональные данные совладельцев карты.

Пример:

Пополнение счета

Запрос

POST
/api2/cards/deposit
? [n=<номер карты>]
& [amount=<сумма пополнения>]
& [currid=<идентификатор валюты>]

Пополнение производится только счета очков-денег.

Идентификатор валюты может принимать значения от 911 до 919. Этим значениям соответствуют настраиваемые позиции валюты банковской карты в справочнике Валюты в приложении Редактор. Название валюты из справочника используется только в отчетах. При печати фискального чека на пополнение через WEB API тип оплаты всегда указывается "Банковская карта".

Ответ

Содержит сумму бонусов, начисленную за пополнение, баланс карты после пополнения и номер операции пополнения в Game-Keeper. Этот номер используется при отмене операции.

...

{
  "errors": [],
  "data": {
    "orderNo": 67508,
    "points": 17847,
    "bonus": 0
  }
}

Отмена пополнения счета

Запрос

POST
/api2/cards/opercancel
? [opid=<номер операции>]

Ответ

Содержит успешность выполнения отмены.

...

{
  "errors": [],
  "data": null
}

Информация о владельце карты

Запрос

GET
/api2/cards//owner
? [n=<номер карты>]

Ответ

Различные данные о владельце карты.

{
    "errors": [],
    "data": {
        "card": 208,
        "first_name": "Иван",
        "last_name": "Иванов",
        "middle_name": "Иванович",
        "birthday": "1999-09-19T00:00:00.0+03:00",
        "gender": 0,
        "phone": "+71234567890",
        "email": "az@b.c",
        "address": "address",
        "mailing_consent": true,
        "personalized": true,
        "in_bonus_program": true

} }

Изменение информации о владельце карте

Запрос

POST
/api2/cards//owner
? [n=<номер карты>]

...

Телефон следует передавать строкой в виде последовательности цифр без разделителей предваряемой знаком +, если с номером телефона планируется работа через приложения Гейм-Кипер (касса, редактор и т.п.). Если номер телефона будет использоваться только через web api, то формат строки может быть любой. Корректность и существование номера телефона или e-mail не проверяются.

Ответ

Содержит успешность выполнения запроса.

...

{
  "errors": [],
  "data": null
}

Информация о совладельцах карты

Запрос

GET
/api2/cards//coowners
? [n=<номер карты>]

Ответ

Различные данные о совладельцах карты.

{
    "errors": [],
    "data": [
        {
            "id": 1,
            "name": "Имя",
            "birthday": "2001-02-05T00:00:00.0+03:00",
            "gender": 1
        },
        {
            "id": 6,
            "name": "Имя",
            "birthday": "2009-12-05T00:00:00.0+03:00",
            "gender": 1
        },
        {
            "id": 7,
            "name": "Имя",
            "birthday": "2015-12-05T00:00:00.0+03:00",
            "gender": 0
        }
    ]
}

Изменение информации о совладельце карте

Запрос

POST
/api2/cards//coowner
? [n=<номер карты>]
& [id=<"id" совладельца при обновлении>]

...

Пол: 0-женский, 1-мужской.

Ответ

Содержит успешность выполнения запроса.

...

{
  "errors": [],
  "data": null
}

Активация электронной карты с альтернативным кодом

...

Запрос

POST
/api2/cards/activate
? [altcode=<альтернативный код карты (внешний ид)>]

Ответ

Содержит номер активированной карты.

...

{
  "errors": [],
  "data": {
    "cardNo": 1000000913
  }
}

Поиск карты по альтернативному коду

Запрос

GET
/api2/cards/search
? [altcode=<альтернативный код карты (внешний ид)>]

Ответ

Если карта найдена, то номер карты, если не найдена, то null.

...

{
  "errors": [],
  "data": null
}

Участник бонусной программы (4.12+ ver)

При обновлении с предыдущих версий необходимо учесть, что настройка chargeBonus4NonpersonalizedCards устарела, вместо нее следует использовать chargeBonus4AnyCards.
Если ранее использовалось ограничение по признаку "Персонализирована", то следует установить признак "Участник бонусной программы" всем персонализированным картам.

Для работы функционала, необходимо:

Сделать настройку, управляющую начислением бонусов для карт, не участвующих в бонусной программе. В ини сервера

[Settings]

chargeBonus4AnyCards

=1 - начисление для любых карт (по умолчанию)

=0 - только с установленным признаком "Участник бонусной программы"

...

ОБРАБОТКА ОШИБОК
Ошибка (элемент массива errors) имеет свойства: 
text - текст ошибки, 
app - код приложения, сгенерировавшего ошибку; при технических ошибках (ошибках подключения) указывает работоспособность какого компонента системы (связи между какими компонентами системы) следует проверять, восстанавливать.
...