Game SDK

Game SDK — это библиотека для интеграции игровых функций, таких как авторизация, управление аудио, получение информации о игроке и продуктах, а также покупка продуктов. SDK предоставляет простой и удобный интерфейс для взаимодействия с игровым API.

Установка

Для установки пакета используйте npm:

npm install game-sdk

Использование

Инициализация

Для начала работы необходимо создать экземпляр класса GameSdk и передать в него опции:

import GameSdk from 'game-sdk';

const gameSdk = new GameSdk({
  type: 'Beeline',
  token: 'EEC9A099-5096-4ABC-9481-6600969B844F', // API токен из админки
  pauseCallback: () => {
    console.log('Audio playback paused');
  },
  resumeCallback: () => {
    console.log('Audio playback resumed');
  }
});

Методы

init()

Инициализирует SDK. Этот метод должен быть вызван перед использованием других методов.

await gameSdk.init();

auth()

Моковая авторизация. Используется для тестирования playground.

await gameSdk.auth();

getWebAppInfo()

Возвращает информацию о веб-приложении.

const appInfo = gameSdk.getWebAppInfo();
console.log(appInfo);

pauseGameAudio()

Останавливает воспроизведение аудио. Вызывает pauseCallback, переданный в опциях.

gameSdk.pauseGameAudio();

resumeGameAudio()

Возобновляет воспроизведение аудио. Вызывает resumeCallback, переданный в опциях.

gameSdk.resumeGameAudio();

getPlayerInfo()

Возвращает информацию об игроке. Если игрок не авторизован, выбрасывается исключение UnauthorizedPlayerException.

try {
  const playerInfo = await gameSdk.getPlayerInfo();
  console.log(playerInfo);
} catch (error) {
  console.error(error.message);
}

getProducts()

Возвращает список доступных продуктов, добавленных в админке.

const products = await gameSdk.getProducts();
console.log(products);

getPurchasedProducts()

Возвращает список купленных продуктов для текущего игрока.

const purchasedProducts = await gameSdk.getPurchasedProducts();
console.log(purchasedProducts);

buyProduct(productId)

Покупает продукт по его идентификатору.

try {
  const purchaseResult = await gameSdk.buyProduct(783);
  console.log(purchaseResult);
} catch (error) {
  console.error(error.message);
}

Обработка ошибок

Все ошибки SDK наследуются от базового класса SdkException. Это позволяет легко отлавливать и обрабатывать исключения, связанные с работой SDK. Ниже приведены все возможные исключения, которые могут быть выброшены при использовании методов SDK.

Иерархия исключений

• SdkException
  Базовый класс для всех исключений SDK. Все остальные исключения наследуются от него.

• UnauthorizedPlayerException
  Выбрасывается, если игрок не авторизован, но был вызван метод, требующий авторизации.
  Пример: вызов getPlayerInfo() без предварительной авторизации.

• UnauthorizedWebAppException
  Выбрасывается, если передан невалидный API ключ.
  Пример: неверный токен при инициализации SDK.

• SessionTokenNotFoundException
  Выбрасывается, если сессионный токен игрока не найден или неверен.
  Пример: попытка выполнить действие, требующее сессионного токена, без его наличия.

• AppNotInitializedException
  Выбрасывается, если SDK не было инициализировано, но был вызван метод, требующий инициализации.
  Пример: вызов любого метода до вызова init().

Полный список исключений

| Исключение | Описание | |-----------------------------------|-------------------------------------------------------------------------| | SdkException | Базовое исключение для всех ошибок SDK. | | UnauthorizedPlayerException | Игрок не авторизован, но вызван метод, требующий авторизации. | | UnauthorizedWebAppException | Передан невалидный API ключ. | | SessionTokenNotFoundException | Сессионный токен игрока не найден или неверен. | | AppNotInitializedException | SDK не инициализировано, но вызван метод, требующий инициализации. |

Лицензия

Этот проект распространяется под закрытой лицензией (Closed License). Любое использование, копирование, распространение или модификация SDK без явного разрешения правообладателя запрещено. Для получения дополнительной информации о лицензировании свяжитесь с нами.

Приятного использования Game SDK!