API

Материал из Warface

   ,  

Главная / API

Прежде чем начать использовать API Warface, рекомендуется познакомиться с базовой информацией о принципах работы API Warface и о подготовке к его использованию, а также с основными понятиями, связанными с API в целом. Если уже имеется опыт работы с нашим API или с аналогичными сервисами других платформ, и знаете, какое приложение или веб‐сайт хотите создать, рекомендуется перейти к описанию методов API Warface. После ознакомления с руководством всё будет зависить лишь от вдохновения разработчика приложения или веб-сайта.

Конечно, на практике никто не работает с API из соседней вкладки браузера. Для этого используются самые разные языки программирования, SDK (software development kit) или генераторы кода. Сам механизм работы с API весьма прост, средства для отправки http‐запросов и обработки ответа от сервера предусмотрены практически в любой среде разработки: а значит, возможность выбора всегда есть.

API (application programming interface) — это посредник между разработчиком приложений или веб‐сайтов и какой‐либо средой, с которой эти приложения или веб‐сайты должны взаимодействовать. API упрощает создание кода, поскольку предоставляет набор готовых классов, функций или структур для работы с имеющимися данными.

API Warface — это интерфейс прикладного программирования, который позволяет получать информацию из базы данных Warface с помощью http‐запросов к специальному серверу. Разработчику приложения или веб‐сайта не нужно знать в подробностях, как устроена база данных, из каких таблиц и полей каких типов она состоит — достаточно того, что API‐запрос об этом «знает». Синтаксис запросов и тип возвращаемых ими данных строго определены на стороне самого сервиса.

Формат запроса

Запросы необходимо отправлять методом GET.

Пример: http://api.warface.ru/user/achievements/?name=[ИМЯ_ПЕРСОНАЖА]&server=[НОМЕР_СЕРВЕРА]

При заполнении полей, например, [ИМЯ_ПЕРСОНАЖА] и [НОМЕР_СЕРВЕРА], квадратные скобки необходимо убирать.

Номера серверов:
   • 1 — «Альфа»,
   • 2 — «Браво»,
   • 3 — «Чарли».
Номера классов персонажей:
   • 1 — Штурмовик,
   • 2 — Медик,
   • 3 — Снайпер,
   • 4 — Инженер.

Формат ответа

API отдаёт данные в формате JSON.

Пример: [{"nickname":"имя1","clan":"-","class":"2","shard":"1"},{"nickname":"имя2","clan":"-","class":"2","shard":"1"}]

Описание функций

Рейтинг топ-100

Данный метод принимает следующие параметры:
   • «Сервер»,
   • «Класс».

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

Пример: http://api.warface.ru/rating/top100?server=[СЕРВЕР]&class=[КЛАСС]

Рейтинг кланов

Данный метод принимает параметр «Сервер».

Пример: http://api.warface.ru/rating/clan?server=[СЕРВЕР]

Ежемесячный рейтинг

Данный метод принимает следующие параметры:
   • «Имя клана» (если передано, показывает данные аналогично опции «Мой клан» на сайте),
   • «Лига» (номера от 1 до 6).

Если используется параметр «Имя клана», в ответе от сервера будут данные о выбранном клане. Там же будет указана именно та лига, в которой этот клан находится, даже если в параметре «Лига» была выбрана не она. Если используется только параметр «Лига», сервер вернёт топ-100 для этой лиги.

Пример: http://api.warface.ru/rating/monthly?server=[СЕРВЕР]&clan=[ИМЯ_КЛАНА]&league=[ЛИГА_1–6]&page=[СТРАНИЦА]

Данные об игроке

Данный метод отдаёт статистику пользователя, принимает следующие параметры:
   • «Имя игрока»,
   • «Сервер».

Пример: http://api.warface.ru/user/stat/?name=[ИМЯ_ПЕРСОНАЖА]&server=[СЕРВЕР]

Данные о достижениях игрока

Данный метод принимает следующие параметры:
   • «Имя игрока»,
   • «Сервер».

Пример: http://api.warface.ru/user/achievements/?name=[ИМЯ_ПЕРСОНАЖА]&server=[СЕРВЕР]

Данные о предметах

Данный метод возвращает полный список доступных в игре предметов, с их id и названием.

Команда: http://api.warface.ru/weapon/catalog

Данные о достижениях

Данный метод возвращает полный список имеющихся в игре достижений, с их id и названием.

Команда: http://api.warface.ru/achievement/catalog

 
Личный кабинет