gkAPI (далее, apiCards2) предназначен для доступа к некоторым данным системы Game-Keeper, а также для внесения изменений в эти данные. Технология реализована со на базе Microsoft Web Server IIS и инструментах платформы .Net Core.
Схема взаимодействия
Внешняя система посылает запрос согласно протоколу обмена на WEB-сервер IIS apiCards2. WEB-сервер обрабатывает запрос и самостоятельно обращается в базу данных, осуществляя чтение или изменение данных. Полученная информация передается обратно внешней системе. Обращение к кассовому серверу используется для служебных нужд.
Состав дистрибутива
Папка с WEB-сервером apiCards2 находится в основном дистрибутиве версии GK в папке ..\GK\gkAPI\api.ext\apiCards2\.
Начиная с версии 418 вспомогательный gkExtServer больше не используется!
Для удобства дальнейшей настройки и навигации необходимо скопировать apiCards2 в папку WEB в корне папки GK.
Настройка подключения apiCards2
Настройка заключается в конфигурировании файла appsettings.json.
Содержимое файла appsettings.json:
{
"Logging": {
"LogLevel": {
"Default": "Warning"
}
},
"AllowedHosts": "*",
"GKPosServer": {
//"useExtServer": true,
"Url": https://127.0.0.1:50302 – ip-адрес, где запущен gkPosServer, 50302 – PortH из gkPosServer.ini
},
"ConnectionStrings": {
"GKDB": "Data Source=127.0.0.1;Initial Catalog=gkArcade;Persist Security Info=True;User ID=sa;Password= 1q2w3e777! " – строка подключения к БД gkArcade.
}
}
Установка платформы .Net Core
Для работы gkApi с версии GK 418 необходимо установить Net Core 5-го поколения!
Установка и настройка Microsoft Web Server IIS
Установка и настройка Microsoft Web Server IIS
В главном окне Диспетчера IIS выбираем элемент дерева «сайты», правой клавишей мыши – Добавить веб-сайт.
Вводим имя сайта, в нашем случае это apiCards2, указываем физический путь к папке cards2, задаем порт для веб-сервиса и нажимаем кнопку «ОК». При вводе имени сайта автоматически будет создан пул приложений для этого сайта с одноименным названием, необходимо в Диспетчере служб IIS перейти в меню дерева «Пулы приложений» и проверить, что пул создался с версией среды CLR.NET v4.0.
Проверка работоспособности
Для проверки работоспособности сервиса gkApi необходимо использовать тестовый механизм apicards2demo. Он располагается в дистрибутиве версии рядом с самим apiCards2:
Настройка подключения в файле Config.js
Содержимое файла:
const baseUrl = "http://127.0.0.1:8081"; - ip-адрес и порт сервиса apiCards2
Непосредственно для проверки запускаем файл index.html
В открывшемся через web-браузер окне вводим номер карты и нажимаем кнопку операции, допустим пополнить баланс:
Заключение
Описание протокола можно найти в Приложение 3. Web API. Описание протокола, или в приложении к gkApi в файле «webApi2. Описание протокола.html». Через интерфейс сторонние системы, приложения, сайты могут получить доступ к некоторым данным Game-Keeper, а также изменять их в соответствии с запросами.
Для возможности использования доступа к базе данных через интерфейс необходимо приобрести лицензию на модуль «WEB API».