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

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

GET

/catalog/big-categories

List Big Categories

Get all top-level categories (e.g., Mobile Games, PC Games, Gift Cards).

Лимит запросов80 req / 60s per user (shared across all catalog endpoints)

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

НазваниеТипОбязательныйОписаниеПример
for_uibooleanНетInclude image URLs in the response.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

List Categories

Get categories, optionally filtered by big category. Each category represents a game or service.

Лимит запросов80 req / 60s per user (shared across all catalog endpoints)

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

НазваниеТипОбязательныйОписаниеПример
bigCategoryIdnumberНетFilter by big category ID.1
for_uibooleanНетInclude image URLs in the response.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

List Subcategories (Products)

Get available products/denominations. Each subcategory is a purchasable item.

Лимит запросов80 req / 60s per user (shared across all catalog endpoints)

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

НазваниеТипОбязательныйОписаниеПример
categoryIdnumberНетFilter by category 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",
      "fulfillment_type": "api",
      "returns_voucher": false
    }
  ]
}
GET

/catalog/subcategory/:itemId/price

Get Item Price

Get the current discounted price for a specific subcategory/item. Use this before creating an order to know the exact cost.

Лимит запросов80 req / 60s per user (shared across all catalog endpoints)

Примечание: The unit_price is what you will be charged. Use this value for expected_unit_price when creating orders.

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

НазваниеТипОбязательныйОписаниеПример
itemIdnumberДаThe subcategory/item 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

Get Category Requirements

Get the dynamic requirement fields for a specific category. These fields describe what information is needed when validating a player or creating an order (e.g., player ID, server, region).

Лимит запросов80 req / 60s per user (shared across all catalog endpoints)

Примечание: Use the returned fields to build dynamic forms for player validation and order creation. Each field specifies its data_type (text, number, single_select, multi_select) and available options for select fields.

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

НазваниеТипОбязательныйОписаниеПример
categoryIdnumberДаThe category ID to get requirements for.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 каталога — категории, товары, цены