Введение¶
Добро пожаловать в документацию платформы для работы с играми. Эта документация предназначена для агентов, которые интегрируются с нашей платформой.
Что такое платформа?¶
Платформа предоставляет игровой контент и API для интеграции. Мы предоставляем единый API для работы с играми, упрощая интеграцию и управление игровым контентом.
Роль агентов в системе¶
Агенты - это партнеры платформы, которые
- Предоставляют доступ к играм своим игрокам
- Управляют балансами игроков
- Обрабатывают игровые транзакции (ставки, выигрыши, отмены)
Сценарий работы¶
Игрок запускает игру¶
- Агент отправляет запрос к платформе:
POST /api/games/get_game_link - Платформа создает игровую сессию и генерирует ссылку на игру
- Платформа возвращает ссылку агенту
- Игрок открывает игру в браузере
Игра запрашивает баланс¶
- Игра отправляет запрос баланса на платформу
- Платформа отправляет коллбек агенту:
getBalance - Агент возвращает текущий баланс игрока
- Платформа возвращает баланс игре
Игрок делает ставку в игре¶
- Игра отправляет информацию о ставке на платформу
- Платформа отправляет коллбек агенту:
makeBet - Агент обрабатывает транзакцию (списывает ставку, начисляет выигрыш)
- Агент возвращает новый баланс игрока
- Платформа обрабатывает ответ
Основные понятия¶
Игровая сессия (Game Session)¶
Уникальная сессия игрока в конкретной игре. Создается при первом запуске игры и используется для всех транзакций в рамках этой игровой сессии.
Транзакция (Transaction)¶
Операция изменения баланса игрока:
- Ставка (Bet) - списание средств со счета игрока
- Выигрыш (Win) - начисление средств на счет игрока
- Отмена (Rollback) - отмена предыдущей транзакции
Баланс (Balance)¶
Текущий баланс игрока в конкретной валюте. Баланс должен быть синхронизирован между агентом и платформой.
Игрок (Player)¶
Игрок идентифицируется двумя параметрами:
player_id- идентификатор игрока в системе агента. Должен быть уникальным для каждого игрока и не изменяться со временем.player_username- имя пользователя игрока. Может быть неуникальным (несколько игроков могут иметь одинаковое имя пользователя).
Важно
player_id используется платформой для идентификации игрока и должен быть уникальным. player_username используется только для отображения.
API токен¶
Секретный ключ, используемый для подписи запросов. Каждый агент имеет свой уникальный API токен, который используется для:
- Подписи запросов к платформе
- Проверки подписи коллбеков от платформы
Что дальше?¶
- Прочитайте раздел Авторизация - узнайте, как авторизовать запросы
- Изучите API методы - методы для получения ссылок на игры и списков игр
- Настройте обработку Коллбеков - запросы, которые платформа будет отправлять вам
Получение доступа¶
Для начала работы вам необходимо:
- Получить учетные данные (agent_id и API токен) от менеджера платформы
- Настроить URL для приема коллбеков (обратитесь к менеджеру для настройки)
- Реализовать обработку коллбеков на вашей стороне
Если у вас возникли вопросы, обратитесь к вашему менеджеру.