API товаров

Иногда товары могут быть временно недоступны из-за технических работ или других причин. Поэтому мы рекомендуем обновлять список доступных товаров и показывать актуальный статус на странице покупки — это удобнее для геймеров и не потребует ручного изменения списка с вашей стороны.

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

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

{
  "status": "200",
  "treasures": [
    {
      "active": true,
      "inputParams": [
        {
          "name": "account",
          "required": true,
          "title": "Введите player id"
        }
      ],
      "type": "item",
      "platform": "genshin-direct",
      "item": "60-genesis-crystals-asia",
      "icon": "genshin-genesis-crystal",
      "title": "60",
      "currency": "Genesis Crystals",
      "region": "asia"
    },
    ...
  ]
}

Полный список возможных полей:

active — флаг доступности товара
inputParams — параметры, которые необходимо передать при создании намерения
type — тип товара
platform — платформа, на которой доступен товар
item — идентификатор товара
icon — иконка товара (можно использовать иконку на нашем CDN: https://cdn.steamgold.dev/items/{icon}.svg)
title — название товара
symbol — символ валюты (если это ваучер в валюте, например: ₽, $, €)
currency — название внутриигровой валюты (если это пополнение аккаунта)
region — регион, в котором доступен товар

Работа с регионами

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

Работа с полями ввода

В поле inputParams содержится список параметров, которые необходимо передать при создании намерения. Эти параметры могут быть обязательными или необязательными. Если параметр обязателен, то в поле required будет значение true, иначе false.

Иногда полем ввода для account может быть электронная почта, в таком случае вы можете либо в форме запрашивать почту для покупки и почту для чека, либо использовать одно поле для ввода почты и передавать его в параметре account и email.

Если у товара больше одного обязательного поля, то все поля кроме account нужно передавать в additionalFields поле при работе с намерением.

Информация

API пополнения