Эндпоинты каталога

Каталог — это дерево из трёх уровней: большие категории содержат категории, категории содержат подкатегории, а подкатегория и есть тот товар, который вы покупаете. Эти эндпоинты позволяют перенести дерево в свою базу и узнать цену товара непосредственно перед заказом.

GET

/catalog/big-categories

Список основных категорий

Возвращает все категории верхнего уровня (например, мобильные игры, игры для ПК, подарочные карты).

Лимит запросов5000 запросов / 60 с на аккаунт (общий лимит для всех эндпоинтов каталога)

Параметры строки запроса

НазваниеТипОбязательныйОписаниеПример
for_uibooleanНетДобавляет в ответ URL изображений.true
Запрос
curl -s "https://shop2topup.com/api/endpoints/v1/catalog/big-categories?for_ui=true" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
Пример ответа
{
  "success": true,
  "big_categories": [
    {
      "id": 1,
      "name": "Mobile Games",
      "description": "Popular mobile game top-ups"
    },
    {
      "id": 2,
      "name": "PC Games",
      "description": "PC game credits and items"
    }
  ]
}
GET

/catalog/categories

Список категорий

Возвращает категории, при желании с фильтром по большой категории. Каждая категория соответствует игре или сервису.

Лимит запросов5000 запросов / 60 с на аккаунт (общий лимит для всех эндпоинтов каталога)

Параметры строки запроса

НазваниеТипОбязательныйОписаниеПример
bigCategoryIdnumberНетФильтр по ID большой категории.1
for_uibooleanНетДобавляет в ответ URL изображений.true
Запрос
curl -s "https://shop2topup.com/api/endpoints/v1/catalog/categories?bigCategoryId=1&for_ui=true" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
Пример ответа
{
  "success": true,
  "categories": [
    {
      "id": 12,
      "name": "Free Fire",
      "description": "Garena Free Fire diamonds",
      "big_category_id": 1,
      "big_category_name": "Mobile Games"
    }
  ]
}
GET

/catalog/subcategories

Список подкатегорий (товаров)

Возвращает доступные товары и номиналы. Каждая подкатегория соответствует одному товару, который можно купить.

Лимит запросов5000 запросов / 60 с на аккаунт (общий лимит для всех эндпоинтов каталога)

Примечание: product_type равен 'topup' для прямого пополнения аккаунта игрока и 'voucher' для товара, который выдаёт код. Поля fulfillment_type ('api' для пополнения, 'voucher' для кода) и returns_voucher (true для кода) устарели: они лишь дублируют product_type. Если в ответе есть поле id, оно совпадает с item_id.

Параметры строки запроса

НазваниеТипОбязательныйОписаниеПример
categoryIdnumberНетФильтр по ID категории.12
Запрос
curl -s "https://shop2topup.com/api/endpoints/v1/catalog/subcategories?categoryId=12" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
Пример ответа
{
  "success": true,
  "subcategories": [
    {
      "item_id": 999,
      "name": "FF 100 Diamonds",
      "description": "100 Free Fire Diamonds",
      "category_id": 12,
      "category_name": "Free Fire",
      "price": "0.99",
      "product_type": "topup",
      "fulfillment_type": "api",
      "returns_voucher": false
    }
  ]
}
GET

/catalog/subcategory/:itemId/price

Цена товара

Возвращает текущую цену со скидкой для конкретной подкатегории (товара). Запроси её перед созданием заказа, чтобы знать точную стоимость.

Лимит запросов5000 запросов / 60 с на аккаунт (общий лимит для всех эндпоинтов каталога)

Примечание: С тебя спишут ровно unit_price. Это же значение передавай в expected_unit_price при создании заказа.

Параметры пути

НазваниеТипОбязательныйОписаниеПример
itemIdnumberДаID подкатегории (товара).999
Запрос
curl -s "https://shop2topup.com/api/endpoints/v1/catalog/subcategory/999/price" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
Пример ответа
{
  "success": true,
  "price": {
    "item_id": 999,
    "item_name": "FF 100 Diamonds",
    "unit_price": "0.950000",
    "currency": "USD",
    "original_price": "0.990000",
    "discount_applied": true,
    "timestamp": "2024-06-15T12:00:00Z"
  }
}
GET

/catalog/category/:categoryId/requirements

Требования категории

Возвращает динамические поля требований для конкретной категории. По ним видно, какие данные нужны для проверки игрока или создания заказа (например, ID игрока, сервер, регион).

Лимит запросов5000 запросов / 60 с на аккаунт (общий лимит для всех эндпоинтов каталога)

Примечание: Строй по этим полям динамические формы для проверки игрока и оформления заказа. У каждого поля указан data_type (text, number, single_select, multi_select), а у полей с выбором ещё и список доступных вариантов.

Параметры пути

НазваниеТипОбязательныйОписаниеПример
categoryIdnumberДаID категории, для которой нужны требования.12
Запрос
curl -s "https://shop2topup.com/api/endpoints/v1/catalog/category/12/requirements" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"
Пример ответа
{
  "success": true,
  "requirements": [
    {
      "field_name": "player_id",
      "data_type": "text",
      "placeholder": "Enter player ID"
    },
    {
      "field_name": "server",
      "data_type": "single_select",
      "placeholder": "Select server",
      "select_options": [
        "Asia",
        "Europe",
        "America"
      ]
    }
  ]
}

Отправьте настоящий запрос прямо с этой страницы

Вставьте API-ключ, чтобы вызвать эти эндпоинты вживую. Ключ остаётся в этой вкладке браузера и отправляется только самому API.

Enter your API key to use the interactive playground. Get your API key

Выберите эндпоинт

Enter your API key above to try this endpoint.

Response will appear here after sending a request.

Обозреватель каталога

Catalog Explorer

Browse the product hierarchy and copy IDs for use in API calls.

Enter your API key above to browse the catalog.

Впервые на платформе? Начните с обзора API пополнения игр для реселлеров, а затем прочитайте обзор реселлерской программы SHOP2TOPUP, чтобы понять, как устроен партнёрский аккаунт.

Справочник API каталога — категории, товары, цены