Устаревшее

Как перейти на новые методы Commerce API

Как это работает

Вы можете подключить Commerce API:

  • если у вас уже реализована серверная интеграция с Иксоллой, и вы хотите перейти на новые методы Commerce API;
  • если вы хотите реализовать серверную интеграцию вашего магазина с Иксоллой с нуля.

Основные возможности:

  • аутентификация пользователей: через продукт Авторизация;
  • через собственную систему аутентификации;
  • управление виртуальными предметами;
  • управление инвентарем пользователя;
  • работа с корзиной и заказом.

Для кого подходит

  • Для партнеров, которые разрабатывают интерфейс магазина и используют стороннее решение для реализации серверной части.
  • Для партнеров, которые уже реализовали серверную интеграцию с Иксоллой и хотят подключить Магазин с новыми методами Commerce API.

Как настроить

Чтобы подключить Commerce API к вашему приложению:

  1. Настройте модуль Виртуальные товары в Личном кабинете.
  2. Настройте аутентификацию.
  3. Реализуйте методы для работы с магазином.

Для настройки запросов к Commerce API вам понадобится один из двух параметров: Project ID или Merchant ID. Параметры отображаются в Личном кабинете в разделе Настройки проекта > Оповещения.

Настройка аутентификации

Возможны следующие варианты аутентификации пользователей:

  • Через продукт Авторизация. Выберите этот вариант, если у вас не реализована серверная интеграция с Иксоллой.
  • Через Pay Station access token. Выберите этот вариант, если у вас реализована серверная интеграция с Иксоллой.

Аутентификация через Xsolla Login

  1. Настройте проект в Личном кабинете.
  2. Реализуйте вызов методов авторизации с помощью JWT или по протоколу OAuth 2.0.

Если данные пользователей хранятся на стороне Иксоллы, реализуйте методы:

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

Если данные пользователей хранятся на вашей стороне, используйте инструкцию для собственного хранилища.

Аутентификация через Pay Station access token

Сценарий взаимодействия вашего клиента и сервера Иксоллы:

  1. Ваш клиент отправляет запрос на аутентификацию на ваш сервер.
  2. Ваш сервер запрашивает токен авторизации, передавая в запросе заголовок с параметрами project_id/merchant_id и api_key на сервер Иксоллы.
  3. Сервер Иксоллы передает токен авторизации в параметре access_token на ваш сервер.
  4. Ваш сервер передает параметр access_token вашему клиенту.

Возвращенный access_token используется как авторизационный токен для аутентификации в Commerce API и построения интерфейса магазина.

Методы для работы с магазином

Реализуйте вызов основных клиентских методов для работы с магазином:

Получение списка товаров на клиенте

  • Get virtual items list — для отображения полного списка виртуальных товаров, добавленных в ваш магазин.
  • Get item groups list — для отображения полного списка групп виртуальных товаров, добавленных в ваш магазин.
  • Получение бандлов — для построения каталога: 
    • Get list of bundles — чтобы получить список всех бандлов для построения каталога.
    • Get specified bundle — чтобы получить бандл по указанному артикулу.

Работа с корзиной и заказом

  • Get cart — для покупки виртуальных товаров — Get cart by ID или Get current user’s cart. Параметр card_id будет использоваться для добавления или удаления товаров.
  • Get order — чтобы определить, была ли покупка обработана. Возможные статусы заказа:
    • New — заказ создан и еще не оплачен.
    • Paid — заказ оплачен.
    • Cancelled — заказ отменен.
    • Done — заказ оплачен и товар добавлен в инвентарь.

Note
Проверка статуса должна проводиться с определенной периодичностью, так как разовая проверка может произойти раньше, чем заказ перейдет в следующий статус.

Заказу будет присвоен статус New.

Для открытия платежного интерфейса в новом окне используйте ссылку: https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, где ACCESS_TOKEN — полученный при создании заказа токен.

Для тестирования процесса оплаты:

  1. Используйте URL: https://sandbox-secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN.
  2. Установите в запросе значение true для параметра sandbox.
  3. Используйте список банковских карт для тестирования.

Управление инвентарем

  • Get user’s inventory — для получения списка предметов в инвентаре пользователя.
  • Get current user virtual balance — для получения информации о виртуальном балансе пользователя на текущий момент.
  • Get current user subscription — для получения информации о подписках пользователя.

Была ли статья полезна?
Спасибо!
Что может сделать страницу еще лучше? Сообщение
Жаль, что так произошло
Расскажите, почему статья не была полезна. Сообщение
Спасибо за обратную связь!
Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.
Оценить страницу
Оценить страницу
Что может сделать страницу еще лучше?

В другой раз

Спасибо за обратную связь!
Последнее обновление: 15 сентября 2020

Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

Сообщите о проблеме
Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
Укажите email-адрес, чтобы мы могли связаться с вами
Спасибо за обратную связь!