Интеграция магазина в игру
После того как вы создали и настроили товары (виртуальные предметы, виртуальные валюты, бандлы, ключи) в Личном кабинете, добавьте магазин в вашу игру:
- Реализуйте отображение каталога товаров.
- Реализуйте логику продажи товаров.
Отображение каталога товаров
Реализуйте отображение каталога с помощью методов In-Game Store API:
Задача | Метод |
---|---|
Отобразить полный список виртуальных предметов, добавленных в ваш магазин | Get virtual items list |
Отобразить на клиенте список групп виртуальных предметов, доступных для продажи | Get item groups list |
Отобразить на клиенте список виртуальных валют, доступных для продажи в вашем магазине | Get virtual currency list |
Отобразить полный список пакетов виртуальных валют, добавленных в ваш магазин | Get virtual currency package list |
Отобразить полный список бандлов, добавленных в ваш магазин | Get list of bundles |
1
при запросе каталога.Продажа товаров
Вы можете продавать товары следующими способами:
- Быстрая покупка одного товара. В этом случае вы можете продавать один артикул товара, но в любом количестве (например, 100 одинаковых зелий или виртуальную валюту).
- Покупка корзины пользователя. В этом случае игрок предварительно наполняет корзину и может добавлять и убирать товары, изменять их количество в одном заказе.
Быстрая покупка
- Используйте метод Create order with specified item. В ответе вы получите токен.
- Откройте платежный интерфейс, используя полученный токен.
Покупка корзины
Реализуйте логику:- Наполнение корзины и получение токена:
- На клиенте — если вы хотите самостоятельно реализовать корзину в своем приложении.
- На сервере — если вы хотите использовать решение Xsolla (методы In-Game Store API) для управления корзиной.
- Открытие платежного интерфейса.
Наполнение и покупка корзины на клиенте
Самостоятельно реализуйте логику добавления и удаления товаров. Также необходимо учитывать, что до вызова метода наполнения корзины у вас не будет информации о том, какие акции будут применены при покупке. Это означает, что итоговая стоимость и сведения о добавленных бонусных предметах будут неизвестны.
- После наполнения корзины игроком используйте метод Fill cart with items для наполнения корзины. В ответе вернется текущая информация о выбранных товарах — цены до и после применения скидок, бонусные товары.
- Используйте метод покупки корзины Create order with all items from current cart. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус New.
- Откройте платежный интерфейс.
Наполнение и покупка корзины на сервере
Этот вариант наполнения корзины может занимать значительное время на настройку, поскольку каждое изменение корзины может сопровождаться вызовом большего количества методов API.
Выполните следующие действия:
- Измените корзину:
- Для добавления товара или изменения его количества используйте метод Update cart item by card ID.
- Для удаления товара используйте метод Delete cart item by card ID.
- Используйте метод покупки корзины Create order with all items from current cart. В ответе вернутся ID заказа и платежный токен. Заказу будет присвоен статус New.
- Откройте платежный интерфейс.
Открытие платежного интерфейса
Чтобы оплатить товары, необходимо открыть платежный интерфейс с токеном, полученным в результате использования метода Create order with all items from current cart.
Реализуйте открытие платежного интерфейса одним из способов:
- В новом окне. Для открытия платежного интерфейса в браузере используйте ссылку:
https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN
, гдеACCESS_TOKEN
— полученный при создании заказа токен. - В виджете. Используйте скрипт Xsolla PayStation Widget (файл README содержит инструкции по выполнению).
Тестирование платежей
Вы можете протестировать систему оплаты, используя тестовый режим (sandbox-режим). Тестирование вы можете выполнять с помощью тестовых карт и с любого аккаунта.
После проведения первого реального платежа в силу вступает строгая политика платежей в тестовом режиме. Проведение платежей будет доступно только для пользователей, которые указаны в Личном кабинете в разделе Настройки компании > Пользователи.
Покупка виртуальной валюты и виртуальных предметов по прямой ссылке за реальную валюту возможна после подписания лицензионного договора с Xsolla. Для этого в Личном кабинете перейдите в раздел Договоры и налоги > Договоры, заполните договор и дождитесь подтверждения согласования. Согласование может занять до 3 рабочих дней.
sandbox
в теле запроса методов быстрой покупки и покупки корзины. По умолчанию тестовый режим выключен.Получение статуса заказа пользователя
Существуют следующие способы получить статус заказа пользователя:
Получение статуса заказа на стороне сервера с помощью вебхуков
После того как вы настроили обработку вебхуков на вашем сервере, вы можете использовать их для получения статуса заказа и информации о заказе.Получение статуса заказа на стороне клиента с помощью WebSocket API или IGS API
Если у вас нет своего сервера или вы используете логику обработки покупок на стороне клиента, вы можете использовать следующие способы:Получение статуса заказа на стороне клиента с помощью веб-сокет-соединения
Решение предусматривает использование веб-сокетов для получения статусов заказа без получения подробной информации о самом заказе. Этот способ является предпочтительным: между клиентом (например, вашим сайтом или мобильным приложением) и сервером Xsolla устанавливается только одно подключение, поэтому нет дополнительной нагрузки ни на клиент, ни на сервер.
Выполните следующие действия:
- Для того чтобы веб-сокет-сервер Xsolla и ваш клиент могли идентифицировать сообщения со статусом заказа, создайте соединение:
- javascript
const client = new Centrifuge(
connectionURL,
{
data: {
user_external_id: user_external_id,
auth: auth,
project_id: project_id
}
}
)
connectionURL - wss://ws-store.xsolla.com/connection/websocket
auth - user JWT token
- Чтобы получать новые сообщения о статусах заказов, подпишитесь на события с помощью функции
client.on
:
- javascript
client.on('publication', (ctx) => {
//handle the status
});
- Установите соединение:
- javascript
client.connect()
- Чтобы получать историю изменений статусов заказов, подключите метод API history method.
- javascript
client.on('subscribed', function (ctx) {
client.history(ctx.channel, { limit: -1, since: { offset: 0 }, reverse: false }).then(function (resp) {
resp.publications.forEach((ctx) => {
/handle the status
});
}, function (err) {
//handle the status
});
});
Пример тела сообщения:
- javascript
{
order_id: 59614241,
status: 'new'
}
Возможны следующие статусы заказа:
New
— заказ создан и еще не оплачен.Paid
— заказ оплачен.Done
— заказ полностью доставлен (в том числе отправлены все чеки, выполнены доставки на стороне Xsolla, внешних платформ и т.д.).Canceled
— заказ отменен, оплата возвращена пользователю.
Рекомендуемое ожидание ответа через веб-сокет — 5 минут. После этого (или если с веб-сокетом есть какие-либо проблемы), рекомендуется использовать простые запросы.
Простые запросы (short-polling)
Чтобы получить детальную информацию о товарах в заказе после перехода в нужный статус, используйте API-метод Get order.
Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.