GAPI Documentation

API Playground

Интерактивное тестирование API с вашим ключом

API Playground

Интерактивная площадка для тестирования всех endpoints API в реальном времени.

Для авторизованных пользователей ключ используется через сессию и не раскрывается в интерфейсе.

Как использовать

  1. Введите API ключ — Вставьте ваш ключ в поле ниже (формат: gapi_...)
  2. Выберите endpoint — Нажмите на кнопку нужного endpoint'а
  3. Настройте параметры — Заполните форму с параметрами запроса
  4. Выполните запрос — Нажмите кнопку "Выполнить" и получите результат

API ключ сохраняется только в вашем браузере (localStorage) и не передаётся на сервер документации.

Интерактивная площадка

Ключ сохраняется только в вашем браузере и не передаётся на сервер документации

Поиск игр

GET/catalog/search

Доступные endpoints

Поиск

  • GET /catalog/search — Полнотекстовый поиск игр
  • GET /catalog/suggest — Быстрые подсказки для автодополнения

Карточки игр

  • GET /catalog/games/:gameId — Детальная информация о PSN игре
  • GET /catalog/battlenet/games/:slug — Детальная информация о Battle.net игре

Служебные

  • GET /catalog/exchange-rates — Актуальные курсы валют
  • GET /catalog/platforms — Список поддерживаемых платформ
  • GET /account/me — Информация о текущем API ключе
  • GET /account/usage — Статистика использования и лимиты

Примеры запросов

Поиск игр

GET /catalog/search?q=god+of+war&platform=psn&limit=5&includeRelated=1

Параметры:

  • q = "god of war"
  • platform = "psn"
  • limit = 5
  • includeRelated = true

Карточка игры

GET /catalog/games/6754AQWE

Параметры:

  • gameId = "6754AQWE"

Проверка лимитов

GET /account/usage

Параметры: нет

Советы по тестированию

Проверка аутентификации

Начните с endpoint'а /account/me чтобы убедиться что ваш ключ работает:

curl -H "Authorization: Bearer gapi_xxxxxxxxxxxxxxxxxxxxx" \
  "https://gapi.qb2.ru/api/v1/account/me"

Тестирование поиска

Используйте разные комбинации параметров:

  1. Базовый поиск: q=witcher
  2. С фильтром платформы: q=witcher&platform=psn
  3. С пагинацией: q=witcher&limit=5&offset=10
  4. Со связанным контентом: q=witcher&includeRelated=1

Проверка rate limiting

Сделайте несколько запросов подряд и следите за заголовками:

X-RateLimit-Remaining-Minute: 27
X-RateLimit-Reset-Minute: 2026-05-05T14:00:00.000Z

Тестирование ошибок

Попробуйте намеренно вызвать ошибки:

  1. 400 Bad Request: Пустой параметр q
  2. 404 Not Found: Несуществующий gameId
  3. 429 Too Many Requests: Превышение лимита (30+ запросов в минуту)

Безопасность

Не делитесь своим API ключом! Ключ даёт полный доступ к вашему аккаунту и лимитам.

Рекомендации

  • Используйте HTTPS — Всегда используйте защищённое соединение
  • Храните ключ безопасно — Не коммитьте ключи в git, используйте переменные окружения
  • Ротация ключей — Периодически создавайте новые ключи и удаляйте старые
  • Мониторинг — Следите за usage в личном кабинете

Что делать если ключ скомпрометирован

  1. Немедленно отзовите ключ в личном кабинете
  2. Создайте новый ключ
  3. Обновите ключ во всех приложениях
  4. Проверьте логи использования на подозрительную активность

Отладка

Проблемы с аутентификацией

Симптом: 401 Unauthorized

Решение:

  1. Проверьте формат ключа (должен начинаться с gapi_)
  2. Убедитесь что заголовок Authorization: Bearer ... правильный
  3. Проверьте статус ключа через /account/me

Проблемы с rate limiting

Симптом: 429 Too Many Requests

Решение:

  1. Проверьте заголовки X-RateLimit-*
  2. Подождите до времени resetAt
  3. Реализуйте exponential backoff
  4. Используйте кэширование для частых запросов

Проблемы с поиском

Симптом: Пустые результаты

Решение:

  1. Проверьте минимальную длину запроса (2 символа)
  2. Попробуйте другой язык (русский/английский)
  3. Уберите фильтр platform для поиска по всем платформам
  4. Проверьте правильность написания

Дополнительные ресурсы

On this page