Перейти к основному содержимому

Глоссарий

Глоссарий помогает одинаково понимать термины, которые встречаются в руководстве, API и документации для разработчиков.

Аккаунты и роли​

Команда​

Организационная область владельца проекта. В команде хранятся проекты, баланс, тариф, пользователи панели и настройки доступа.

Администратор​

Сотрудник или владелец, который входит в SaaS-панель MMO-DEV WEB и управляет проектами, серверами, пользователями, платежами, плагинами и настройками.

Пользователь​

Игрок или клиент проекта. В документации API пользователь обычно связан с мастер-аккаунтом, сессиями, контактами, балансами и игровыми аккаунтами.

Мастер-аккаунт​

Основной аккаунт пользователя в кабинете проекта. Через него пользователь входит в кабинет, управляет email, Telegram, социальными профилями, PIN, 2FA и связанными игровыми аккаунтами.

Игровой аккаунт​

Аккаунт внутри игрового сервера. Он может иметь отдельный логин, пароль, персонажей, склад, ограничения и операции обслуживания.

Связанный аккаунт​

Подтвержденная двусторонняя связь между учетными записями одного проекта. Она разрешает быстрое переключение, но не объединяет балансы, склады или игровые аккаунты.

Проекты и серверы​

Проект​

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

Сервер​

Общее название серверной сущности проекта. В зависимости от контекста может означать игровой сервер, login server или выбранный сервер пользователя.

Игровой сервер​

Конкретный игровой мир, shard или realm. Для него настраиваются платформа, подключение к базе, статистика, рейтинги, персонажи, магазин, кейсы и игровые услуги.

Login server​

Сервер авторизации игры. Он используется для проверки игровых аккаунтов, смены паролей и операций, связанных с логинами игрового сервера.

Выбранный сервер​

Сервер, который закреплён в пользовательской сессии и используется авторизованными операциями, если операция не принимает явный gameServerId.

Платформа​

Тип игровой интеграции, например Lineage 2 или другая поддерживаемая платформа. API определяет платформу по проверенной конфигурации проекта и сервера.

API​

GraphQL endpoint​

HTTP-точка проекта, обычно /graphql, куда отправляются все API-запросы.

documentId​

Идентификатор разрешённого GraphQL-документа. Вместо передачи произвольного GraphQL-текста клиент отправляет documentId, например me, login, servers или preparePlayerWalletTopUp.

variables​

Объект переменных операции. Если операция не принимает входные данные, передаётся пустой объект {}.

Context token​

Публичный токен контекста проекта из identity.contextToken. Он передаётся в заголовке X-Project-Context и связывает API-запрос с конкретным проектом.

X-Project-Context​

Обязательный HTTP-заголовок API. В него передаётся context token из актуальной конфигурации проекта. Его нельзя собирать вручную из ID проекта или сервера.

Authorization​

HTTP-заголовок вида Authorization: Bearer <sessionId>. Используется для операций, которые требуют авторизованного пользователя.

sessionId​

Токен пользовательской сессии, который возвращают операции входа. Передаётся в Authorization для последующих запросов.

Input-тип​

Структура входных данных GraphQL-операции. В документации API input-типы вынесены в справочник схем API.

Result-тип​

Структура ответа GraphQL-операции. Используется, чтобы понять, какие поля вернёт операция и какие вложенные объекты доступны клиенту.

Enum​

Перечисление допустимых значений поля. Например, статус, тип провайдера, метод действия или категория сущности.

Ошибка API​

Стандартный GraphQL-ответ с массивом errors. Категория ошибки обычно находится в errors[].extensions.category.

Игровые и пользовательские данные​

Склад​

Хранилище предметов, наград и покупок пользователя. Со склада пользователь может выбрать получателя и передать предмет персонажу.

Персонаж​

Игровая сущность внутри игрового аккаунта. Используется в операциях инвентаря, выдачи предметов, статистики и игровых сервисов.

Платёж​

Операция пополнения или покупки. В API платёж содержит способ оплаты, сумму, результат и состояние обработки.

Расчёт покупки​

Короткоживущий серверный результат подготовки покупки. Он содержит проверенное предложение, получателя, скидки, итоговую сумму и срок действия. Клиент показывает этот результат и передаёт его идентификатор в следующую операцию, но не пересчитывает сумму самостоятельно.

Плагин​

Подключаемое расширение платформы: магазин, кейсы, колесо удачи, поддержка, игровой рынок, промо-игры и другие модули.

Модуль​

Функциональная часть платформы или плагина. В API термин часто используется для игровых сервисов: магазин, награды, поддержка, голосования и уведомления.

Разработка​

Шаблон​

Twig-файл клиентского сайта или кабинета. Шаблоны отвечают за HTML-разметку и используют данные, подготовленные платформой.

Twig namespace​

Псевдоним директории шаблонов, например @site, @cabinet, @admin или @common.

Asset​

Статический ресурс: CSS, JavaScript, изображение или шрифт. В Twig обычно подключается через функцию asset().

Webhook​

HTTP-вызов во внешнюю систему при наступлении события. Если интеграция использует webhook, endpoint должен проверять подпись, источник и повторную доставку.