Просмотреть исходный

apiCards2 предназначен для доступа к некоторым данным системы Game-Keeper, а также для внесения изменений в эти данные. Технология реализована на базе Microsoft Web Server IIS и инструментах платформы .Net Core.

Начиная с версии 431, Web-Api работает на Net Core 8-го поколения!
Так же изменился конфигурационный файл с версией Web-Api 4.17. Изменения описаны ниже в документации.

Для возможности использования доступа к базе данных через интерфейс необходимо приобрести лицензию на модуль «WEB API».

Схема взаимодействия

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2021-10-18_13-43-16.png

Внешняя система посылает запрос согласно протоколу обмена на WEB-сервер IIS apiCards2. WEB-сервер обрабатывает запрос и самостоятельно обращается в базу данных, осуществляя чтение или изменение данных. Полученная информация передается обратно внешней системе. Обращение к кассовому серверу используется для служебных нужд.

Состав дистрибутива

Для удобства дальнейшей настройки и навигации необходимо скопировать apiCards2 в папку WEB в корне папки GK.

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2021-10-18_13-45-9.png

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2021-10-18_13-45-20.png

Настройка подключения apiCards2

Настройка заключается в конфигурировании файла apiCards2.config.json.

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image-2024-11-20_18-17-47.png

Содержимое файла apiCards2.config.json :

{
"Logging": {
"LogLevel": {
"Default": "Warning"
}
},
"AllowedHosts": "*",
"GKPosServer": {
"Url": "https://127.0.0.1:50302" – ip-адрес, где запущен gkPosServer, 50302 – PortH из gkPosServer.ini.
},
"ConnectionStrings": {
"GKDB": "Data Source=127.0.0.1;Initial Catalog=gkArcade;TrustServerCertificate=True;User ID=sa;Password=" – строка подключения к БД gkArcade.
}
//"api-users": [
// {
// "key": "value"
// }
//]
}

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2021-10-18_13-46-50.png

Установка платформы .Net Core

Для работы apiCards2 с версии GK 431 необходимо установить Net Core 8-го поколения!

Установка платформы .Net Core

Установка и настройка Microsoft Web Server IIS

Установка и настройка Microsoft Web Server IIS

В главном окне Диспетчера IIS выбираем элемент дерева «сайты», правой клавишей мыши – Добавить веб-сайт.

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2021-10-18_13-48-22.png

Вводим имя сайта, в нашем случае это apiCards2, указываем физический путь к папке cards2, задаем порт для веб-сервиса и нажимаем кнопку «ОК». При вводе имени сайта автоматически будет создан пул приложений для этого сайта с одноименным названием, необходимо в Диспетчере служб IIS перейти в меню дерева «Пулы приложений» и проверить, что пул создался с версией среды CLR.NET v4.0.

База знаний > API для внешних систем (WEB API) начиная с версии GK 431 > image2020-4-3_20-21-12.png

Заключение

Описание протокола можно найти в Приложение 3. Web API. Описание протокола, или в приложении к gkApi в файле «webApi2. Описание протокола.html». Через интерфейс сторонние системы, приложения, сайты могут получить доступ к некоторым данным Game-Keeper, а также изменять их в соответствии с запросами.

К оглавлению.